{"openapi":"3.0.3","info":{"title":"Loads","description":"Manage loads on the Transport Exchange Group Freight Exchange platform.","version":"2.0"},"servers":[{"url":"https://app.staging.transportexchangegroup.com/api/v2","description":"Staging server"},{"url":"https://app.transportexchangegroup.com/api/v2","description":"Production server"}],"paths":{"/loads":{"post":{"tags":["Create, return, update, and delete loads"],"summary":"Create a load","description":"This method allows users to create an unallocated load or a load assigned to a specific delivery driver/company. Unallocated loads are automatically created with the status `\"POSTED\"` and available drivers can bid for them. Allocated loads are referred to as bookings and must be allocated to your own company when using this method.","operationId":"createLoadUsingPOST","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoadDto"},"example":{"customerAgreedRate":67.67,"currency":"GBP","yourReference":"bb4","showYourReferenceToSubcontractor":true,"customerReference":"customer reference","showCustomerReferenceToSubcontractor":true,"readyAt":"2022-04-13T12:59:00.000Z","collectBy":"2022-04-13T14:00:00.000Z","pickupTimeRange":"BETWEEN","fromTimeZoneId":"Europe/London","from":{"country":"GB","postcode":"NN17 5QT","building":"12 house","fullAddress":"15111 Mitchell Road Corby NN17 5QT GB","coordinates":{"lng":-0.3415602,"lat":51.5800424}},"stops":[{"stopOrder":1,"type":"PICKUP","timeRange":"BETWEEN","timeFrom":"2022-04-13T12:59:00.000Z","timeTo":"2022-04-13T14:00:00.000Z","stopDisplayTime":"09:00 – 15:00 BST | 31 Mar","timeZoneName":"Europe/London","address":{"country":"GB","postcode":"NW8 9","building":"Flat 15","fullAddress":"14 Abbey Road London NW8 9 United Kingdom","coordinates":{"lng":-0.1776786,"lat":51.5326312}},"contact":{"companyName":"Abbey Road corp.","contactName":"Billy","notes":"Billy notes","phone":447776661122,"email":"billy@abbeyroad.com"},"ownerNotes":"2 containers"}],"deliverFrom":"2022-04-13T14:00:00.000Z","deliverBy":"2022-04-13T14:00:00.000Z","deliverTimeRange":"BETWEEN","toTimeZoneId":"Europe/London","to":{"country":"GB","town":"Shefford","postcode":"SG17 5NL","building":"apartment 45","fullAddress":"5 St Marys Place Shefford SG17 5NL GB","coordinates":{"lng":-0.3452462,"lat":52.0108181},"streetNumber":5,"route":"St Marys Place","locality":"Shefford"},"order":{"collection":{"companyName":"Cargo Van","contactName":"John","phone":445678764312,"email":"cargovan@email.com","addressLine1":"Corby","addressLine2":"15 Mitchell Road","addressLine3":"Corby","postcode":"NN17 5QT","notes":"Pickup Notes"},"delivery":{"companyName":"Leeds Delivery","contactName":"Carl","phone":445557778899,"email":"leeds@del.com","-addressLine1":"Shefford","addressLine2":"5 St Marys Place","addressLine3":"Shefford","postcode":"SG17 5NL","notes":"Delivery notes"}},"jobDescription":"DELIVER_DIRECT","jobDisplayDescription":"Deliver Direct","minVehicleSize":"12T","jobType":"HOTSHOT","bodyType":"LOWLOADER","freightType":"FROZEN","packaging":"BALES","hiab":true,"twoMan":true,"moffetMounty":true,"waitAndReturn":true,"liftgate":true,"euroLoad":true,"tailLift":true,"trailer":true,"enrouteEmail1":"myemail2@mail.com","enrouteEmail2":"myemail3@mail.com","enrouteEmail3":"myemail4@mail.com","sendEnrouteToMyEmailAddress":true,"sendEnrouteAccordingGeofence":true,"frequencyForEnrouteEmail":900,"volume":{"width":2,"height":1,"length":3,"units":"m"},"grossWeight":{"value":500,"units":"kg"},"cubicMetres":{"unitEnum":"M3","value":6},"loadingMetres":{"unit":0,"value":3},"numberOfItems":5,"trackedDriverPreferred":true,"notificationRadius":25,"quotesEnabled":true,"acceptanceRequired":true,"notes":"This is test load","callbackRequired":true}}},"description":"loadDto","required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityCreatedResult"},"example":{"id":12345}}}},"202":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityCreatedResult"},"example":12345}}},"400":{"description":"Bad request","content":{"text/plain":{"schema":{"type":"string"},"examples":{"causes":{"value":"can happen if numberOfItems field contains string value or value not provided"}}}}},"401":{"description":"Not authorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity","content":{"text/plain":{"schema":{"type":"string"},"examples":{"'deliverBy' must not be empty":{"description":"`deliverBy` field missing or empty.","value":"'deliverBy' must not be empty"},"freightType is required":{"description":"`freightType` field missing or empty.","value":"freightType is required"},"collectBy is required":{"description":"`collectBy` field missing or empty.","value":"collectBy is required"},"'deliverFrom' must not be empty":{"description":"`deliverFrom` field missing or empty.","value":"'deliverFrom' must not be empty"},"from is required":{"description":"`from` field missing or empty.","value":"from is required"},"to is required":{"description":"`to` field missing or empty.","value":"to is required"},"jobDescription is required":{"description":"`jobDescription` field missing or empty.","value":"jobDescription is required"},"minVehicleSize is required":{"description":"minVehicleSize field missing or empty.","value":"minVehicleSize is required"},"readyAt is required":{"description":"readyAt field missing or empty.","value":"readyAt is required"},"packaging, numberOfItems should be set or empty":{"description":"Either packaging OR numberOfItems are missing. If both fields are missing there is no error.","value":"packaging, numberOfItems should be set or empty"}}}}}},"security":[{"ApiKeyAuth":[]}]},"get":{"tags":["Create, return, update, and delete loads"],"summary":"Get loads in a given time range","description":"This method returns a list of loads posted within a set date range.","operationId":"getLoads","parameters":[{"name":"dateFrom","in":"query","description":"start of date range","schema":{"type":"string","example":"2022-01-24T00:00:00Z"}},{"name":"dateTo","in":"query","description":"end of date range","schema":{"type":"string","format":"date-time","example":"2022-01-25T00:00:00Z"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyLoadsDto"},"example":{"data":[{"loadId":1705442,"createdOn":"2022-01-24T11:19:51.000Z","status":"POSTED","statusDate":"2022-01-24T11:19:51.000Z"},{"loadId":1705444,"createdOn":"2022-01-24T11:20:06.000Z","status":"CANCELLED","statusDate":"2022-01-24T11:20:53.000Z"},{"loadId":1705446,"createdOn":"2022-01-24T11:20:17.000Z","status":"COMPLETED","statusDate":"2022-01-24T11:20:26.000Z"},{"loadId":1705448,"createdOn":"2022-01-24T11:20:36.000Z","status":"BOOKED","statusDate":"2022-01-24T11:20:36.000Z"},{"loadId":1705450,"createdOn":"2022-01-24T11:21:04.000Z","status":"BOOKED","statusDate":"2022-01-24T11:25:08.000Z"},{"loadId":1705458,"createdOn":"2022-01-24T11:52:29.000Z","status":"BOOKED","statusDate":"2022-01-24T11:52:29.000Z"},{"loadId":1705460,"createdOn":"2022-01-24T13:23:31.000Z","status":"BOOKED","statusDate":"2022-01-24T13:23:43.000Z"},{"loadId":1705462,"createdOn":"2022-01-24T13:23:43.000Z","status":"POSTED","statusDate":"2022-01-24T13:23:43.000Z"},{"loadId":1705464,"createdOn":"2022-01-24T13:23:50.000Z","status":"POSTED","statusDate":"2022-01-24T13:23:50.000Z"},{"loadId":1705466,"createdOn":"2022-01-24T13:23:59.000Z","status":"BOOKED","statusDate":"2022-01-24T13:23:59.000Z"},{"loadId":1705468,"createdOn":"2022-01-24T13:25:34.000Z","status":"BOOKED","statusDate":"2022-01-24T13:25:34.000Z"},{"loadId":1705470,"createdOn":"2022-01-24T13:27:58.000Z","status":"POSTED","statusDate":"2022-01-24T13:27:58.000Z"},{"loadId":1705478,"createdOn":"2022-01-24T13:59:23.000Z","status":"BOOKED","statusDate":"2022-01-24T13:59:23.000Z"}],"paging":{"total":13}}}}},"401":{"description":"Not authorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"BasicAuth":[]},{"ApiKeyAuth":[]}]}},"/load/{loadId}/order":{"post":{"tags":["Confirm load bookings and update their status"],"summary":"Confirm booking for existing load","description":"Create booking confirmation for existing load in `\"POSTED\"` status. Company users have ability to create load only behalf of their own company.\n## Usage Rules\nIf subcontractorId is NOT known load should be booked with two steps:\n1. Receive company ID by <a href=\"#operation/getCompanyInfoUsingGET\">Get company brief</a>.\n2. Use receiving company ID as subcontractor ID.","operationId":"bookLoadUsingPOST","parameters":[{"name":"loadId","in":"path","description":"load ID","required":true,"schema":{"type":"integer","format":"int64","example":"1234"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderDto"},"example":{"subcontractorId":107427,"agreedRate":123,"paymentTerm":"30EOM"}}},"description":"orderDto","required":true},"responses":{"200":{"description":"OK"},"201":{"description":"Created"},"401":{"description":"Not authorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"}},"security":[{"ApiKeyAuth":[]}]}},"/loads/{loadId}/subcontractor":{"post":{"tags":["Assign loads"],"summary":"Assign load to subcontractor","description":"This method allows users to assign an existing load to a subcontractor.","operationId":"reassignLoadToSubContractorUsingPOST","parameters":[{"name":"loadId","in":"path","description":"load ID","required":true,"schema":{"type":"integer","format":"int64","example":"1234"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderDetailsDto"},"example":{"subcontractor":106115,"driverPhoneNumber":3244432432,"paymentTerm":"7FI","agreedRate\"":123,"enrouteEmailToSubcontractror":true,"notes":"Some notes"}}},"description":"orderDetails","required":true},"responses":{"200":{"description":"OK"},"201":{"description":"Created"},"401":{"description":"Not authorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity","content":{"text/plain":{"schema":{"type":"string"},"example":"Subcontractor should be connected driver or AdHoc company"}}}},"security":[{"ApiKeyAuth":[]}]}},"/loads/{loadId}/ownDriver":{"post":{"tags":["Assign loads"],"summary":"Assign existing load to vehicle","description":"This method allows you to assign an existing load to own driver vehicle and employee driver.","operationId":"reassignLoadUsingPOST","parameters":[{"name":"loadId","in":"path","description":"load ID","required":true,"schema":{"type":"integer","format":"int64","example":"1234"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReassingLoadToOwnDriverDto"},"example":{"userId":147810,"vehicleId":82294}}},"description":"dto","required":true},"responses":{"200":{"description":"OK"},"201":{"description":"Created"},"401":{"description":"Not authorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"}},"security":[{"ApiKeyAuth":[]}]}},"/load/{loadId}":{"get":{"tags":["Create, return, update, and delete loads"],"summary":"Get load","description":"Returns load by ID for owner including POD and order information.","operationId":"getLoadUsingGET","parameters":[{"name":"loadId","in":"path","description":"load ID","required":true,"schema":{"type":"integer","format":"int64","example":"1234"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoadDto"},"example":{"loadId":1309838,"ownerId":106115,"bookerId":140953,"ownerDisplayName":"John Smith","phoneNumber":4412345678900,"ownerCxId":"GB 106115","reference":1309838,"yourReference":"YREF","customerReference":"CREF3","showYourReferenceToSubcontractor":true,"showCustomerReferenceToSubcontractor":true,"from":{"country":"GB","town":"London","postcode":"NW8","fullAddress":"London United Kingdom","coordinates":{"lng":-0.12714,"lat":51.50639},"route":null,"locality":null},"fromShortDisplayAddress":"London United Kingdom","fromDisplayAddress":"12 Fleet Street","readyAt":"2019-12-11T12:00:00.000Z","collectBy":"2019-12-11T12:00:00.000Z","fromTimeZone":{"name":"Europe/London","timeZone":"Europe/London","shortName":"GMT"},"fromTimeZoneId":"Europe/London","distance":194.3,"duration":12388,"paymentDisplayTerms":"45 Days (From Invoice)","to":{"country":"GB","town":"Leeds","postcode":null,"fullAddress":"Leeds United Kingdom","coordinates":{"lng":-1.54656,"lat":53.79487},"route":null,"locality":null},"toShortDisplayAddress":"Leeds United Kingdom","toDisplayAddress":"Leeds United Kingdom","deliverFrom":"2019-12-11T16:05:00.000Z","deliverBy":"2019-12-11T16:05:00.000Z","toTimeZone":{"name":"Europe/London","timeZone":"Europe/London","shortName":"GMT"},"toTimeZoneId":"Europe/London","jobDescription":"DELIVER_DIRECT","freightType":"NA","notes":null,"notificationRadius":0,"status":"BOOKED","invoiced":false,"vehicleDisplayName":"Motorcycle","minVehicleSize":"Bike","minVehicleSizeApiKey":"Bike","bodyType":"NA","liftgate":false,"tailLift":false,"hiab":false,"trailer":false,"moffetMounty":false,"waitAndReturn":false,"twoMan":false,"currency":"GBP","pickupTimeRange":"AT","deliverTimeRange":"ASAP","order":{"subcontractorId":106115,"executorVehicleId":82156,"agreedRate":2334,"paymentTerm":"21FI","billingName":"John Smith","billingAddress1":"Harrow GB","billingAddress2":"Kirkwall","billingTown":"Harrow","billingState":"Aberdeenshire","billingCountry":"GB","billingPostcode":"HA1 1BH","billingEmail":"john.smith@example.com","billingPhone":"+44 123456771","collection":{"companyName":"Stuff Inc","contactName":"Ian Hacking","phone":"+44 123456771","addressLine1":"1 Business Park","addressLine2":"Manchester","addressLine3":null,"postcode":"M1 A12"},"delivery":{"companyName":"Delivery Solutions","contactName":"Wesley Salmon","phone":447771122666,"addressLine1":"1 Drawbridge Street","addressLine2":"London","addressLine3":null,"postcode":"EC3 ABC"},"via":{"companyName":"Truckers Inc","contactName":"Jane Smythe","phone":447776661122,"addressLine1":"1 Footbridge Road","addressLine2":"Worcester","addressLine3":null,"postcode":"W1 123"},"accessorials":[{"apiKey":"CONGESTION_CHARGE","price":333}],"totalPrice":2667,"subcontractorName":"Jane Doe","subcontractorDisplayCompanyId":"GB 106115","subcontractorPhone":"+44 123456771","subcontractorEmail":"jane.doe@example.com","postedAt":"2019-12-11T12:23:10.000Z","jobType":"HOTSHOT","jobDisplayTypeShort":"H/SHOT","jobDisplayDescription":"Deliver Direct","bookingFooter":"BOOKING FOOTER PARENTd","pickupTime":"12:00 GMT | 11 Dec","deliveryTime":"ASAP","acceptanceRequired":true,"podHardCopiesRequired":false,"trackedDriverPreferred":false,"enrouteEmail1":"john.smith@example.com","enrouteEmail2":"jane.doe@example.com","enrouteEmail3":"joe.smythe@example.com","sendEnrouteToMyEmailAddress":false,"frequencyForEnrouteEmail":7200,"sendEnrouteAccordingGeofence":false,"quotesEnabled":false,"callbackRequired":false,"ulezCrossed":true,"createdOn":"2019-12-11T12:23:10.000Z","euroLoad":false,"cleanZones":[{"id":1,"displayName":"ULEZ"}]}}}}},"401":{"description":"Not authorized"},"403":{"description":"Forbidden"},"404":{"description":"Not found"}},"security":[{"ApiKeyAuth":[]}]},"put":{"tags":["Create, return, update, and delete loads"],"summary":"Update your load","description":"Enables you to update your load.","operationId":"updateLoadUsingPUT","parameters":[{"name":"loadId","in":"path","description":"load ID","required":true,"schema":{"type":"integer","format":"int64","example":"1234"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoadDto"},"example":{"minVehicleSize":"M/Van","yourReference":"dp6","customerReference":"CREF3","showYourReferenceToSubcontractor":false,"showCustomerReferenceToSubcontractor":false,"from":{"country":"GB","town":"Belfast","postcode":"BT7 1NN","fullAddress":"University Rd Belfast BT7 1NN UK"},"fromShortDisplayAddress":"BELFAST BT7 1NN","fromDisplayAddress":"University Road BELFAST BT7 1NN","readyAt":"2022-04-13T12:59:00.000Z","collectBy":"2022-04-13T14:00:00.000Z","fromTimeZoneId":"Europe/London","paymentDisplayTerms":"45 Days (From Invoice)","to":{"country":"GB","town":"London","postcode":"WC2R 2LS","fullAddress":"Strand London WC2R 2LS UK"},"deliverFrom":"2022-04-13T12:59:00.000Z","deliverBy":"2022-04-13T14:00:00.000Z","toTimeZone":{"name":"Europe/London","timeZone":"Europe/London","shortName":"BST"},"toTimeZoneId":"Europe/London","jobDescription":"DELIVER_DIRECT","freightType":"NA","notes":"Test load notes","invoiced":false,"vehicleDisplayName":"Car","bodyType":"NA","liftgate":false,"tailLift":false,"hiab":false,"trailer":false,"moffetMounty":true,"waitAndReturn":true,"twoMan":true,"currency":"GBP","pickupTimeRange":"BETWEEN","deliverTimeRange":"ASAP","order":{"subcontractorId":107427,"executorVehicleId":17635,"agreedRate":2,"paymentTerm":"45FI","billingName":"John Smythe","billingAddress1":"Harrow GB","billingAddress2":"Kirkwall","billingTown":"Harrow","billingState":"Aberdeenshire","billingCountry":"GB","billingPostcode":"HA1 1BH","billingEmail":"vlad_company@mailinator.com","billingPhone":"+44 123456771","collection":{"companyName":"Pickup Solutions","contactName":"Jane Doe","phone":"+44 123456771","addressLine1":"1 Footbridge Road","addressLine2":"Granchester","addressLine3":null,"postcode":"AB1 C23"},"delivery":{"companyName":"Sending Solutions","contactName":"John Doe","phone":"+44 123456771","addressLine1":"1 Yellowbrick Road","addressLine2":"Edinburgh","addressLine3":null,"postcode":"EH1 123"},"via":{"companyName":"Trucking Solutions","contactName":"Nelson Goodman","phone":"+44 123456771","addressLine1":"4 Wheel Drive","addressLine2":"Easthampton","addressLine3":null,"postcode":"ABC 123"},"subcontractorName":"Karl Popper","subcontractorDisplayCompanyId":"GB 107427","subcontractorPhone":"+44380 954043004","subcontractorEmail":"karl.popper@subcontractor.com"},"jobType":"HOTSHOT","jobDisplayTypeShort":"H/SHOT","jobDisplayDescription":"Deliver Direct","bookingFooter":"Commenced trading in March 2007. \\nWe are based in Doncaster. Operate Small Vans up to 5t trucks.\\nWe do local domestic and International road 24/7.\\n\\nRegards MousE","pickupTime":"10:55 – 11:55 BST | 19 Jul","acceptanceRequired":false,"commodity":null,"podHardCopiesRequired":false,"trackedDriverPreferred":false,"sendEnrouteToMyEmailAddress":false,"frequencyForEnrouteEmail":1800,"sendEnrouteAccordingGeofence":false,"callbackRequired":false,"ulezCrossed":true}}}},"responses":{"200":{"description":"OK"},"201":{"description":"Created"},"401":{"description":"Not authorized"},"403":{"description":"Forbidden"},"404":{"description":"Not found"},"422":{"description":"Unprocessable Entity"}},"security":[{"ApiKeyAuth":[]}]},"delete":{"tags":["Create, return, update, and delete loads"],"summary":"Cancel your load","description":"Change load status from `\"POSTED\"` or `\"BOOKED\"` to `\"CANCELLED\"`.","operationId":"deleteLoadUsingDELETE","parameters":[{"name":"loadId","in":"path","description":"load ID","required":true,"schema":{"type":"integer","format":"int64","example":"1234"}}],"responses":{"200":{"description":"OK"},"201":{"description":"Created"},"401":{"description":"Not authorized"},"403":{"description":"Forbidden"},"404":{"description":"Not found"},"422":{"description":"Unprocessable Entity"}},"security":[{"ApiKeyAuth":[]}]}},"/load/{loadId}/bookingStatus":{"post":{"tags":["Confirm load bookings and update their status"],"summary":"Set booking status","description":"Enables user to set status of load.","operationId":"postBookingStatusUsingPOST","parameters":[{"name":"loadId","in":"path","description":"load ID","required":true,"schema":{"type":"integer","format":"int64","example":"1234"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BookingStatusDto"},"example":{"bookingStatus":"LOADED","loadedInfo":{"noOfItems":12},"weight":13,"weightUnit":"kg","ourRef":"OURREF1","customerRef":"CREF3","notes":"Notes","yourRef":"YREF1","eta":"2019-10-24T15:25:00.000Z","etaTimeZoneId":18,"etaTimeZoneStringId":"Europe/London"}}},"description":"bookingStatusDto","required":true},"responses":{"200":{"description":"OK"},"201":{"description":"Created"},"401":{"description":"Not authorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"ApiKeyAuth":[]}]},"get":{"tags":["Get information about loads"],"summary":"Get the booking status of a load.","description":"Returns booking status by load ID for owner and executor. Response includes `pod` and `loadedInfo`, which contains key load statistics such as weight and number of items.","operationId":"getBookingStatusUsingGET","parameters":[{"name":"loadId","in":"path","description":"load ID","required":true,"schema":{"type":"integer","format":"int64","example":"1234"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BookingStatusDto"},"example":{"bookingStatus":"DELIVERED","statusTime":"2020-10-08T15:11:21.000Z","loadedInfo":{"noOfItems":3333,"weight":333333,"weightUnit":"kg","yourRef":"YREF","customerRef":"CREF","eta":"2020-10-10T15:10:00.000Z","notes":"some notes"},"pod":{"deliveredOn":"2020-10-08T15:15:00.000Z","deliveryTimeZone":"Europe/London","deliveryStatus":"COMPLETED","receivedBy":"RECEIVER","leftAt":"RECEIVING_DEPARTMENT","notes":"Some notes","noOfItems":3333,"weight":333333,"weightUnit":"kg","released":false}}}}},"401":{"description":"Not authorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"ApiKeyAuth":[]}]}},"/loads/{loadId}/stops/{stopId}/docsInfo":{"get":{"tags":["Manage stop-offs for loads"],"summary":"Return stop document information","description":"Enables users to view POD and photo pertaining to a specific stop for a load.","operationId":"getStopDocumentInformationUsingGET","parameters":[{"name":"loadId","in":"path","description":"load ID","required":true,"schema":{"type":"integer","format":"int64","example":"1234"}},{"name":"stopId","in":"path","description":"stop ID","required":true,"schema":{"type":"integer","format":"int64","example":"2"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DocInfoDto"}},"example":{"attachmentType":"POD","companyId":1002,"date":"2022-02-14T12:00:00Z","documentType":"pod","fileNameExtension":"pdf","id":1234,"name":"Proof of Delivery","size":2000,"userId":345}}}},"401":{"description":"Not authorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"ApiKeyAuth":[]}]}},"/loads/{loadId}/docs":{"post":{"tags":["Upload, get, download, and delete load documentation"],"summary":"Upload a document to load","description":"Users from company owner and company sub-contractor have the ability to upload document for load. Method allows to upload document for load.","operationId":"uploadDocumentUsingPOST","parameters":[{"name":"loadId","in":"path","description":"load ID","required":true,"schema":{"type":"integer","format":"int64","example":"1234"}}],"requestBody":{"$ref":"#/components/requestBodies/uploadDocumentUsingPOST"},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocInfoDto"}}}},"201":{"description":"Created"},"401":{"description":"Not authorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"}},"security":[{"ApiKeyAuth":[]}]}},"/load/{loadId}/pod/signature":{"get":{"tags":["Get and create proof of delivery (POD) documentation"],"summary":"Get POD returns signature","description":"Get POD returns signature by load ID for owner and carrier.","operationId":"getPodSignatureUsingGET","parameters":[{"name":"loadId","in":"path","description":"load ID","required":true,"schema":{"type":"integer","format":"int64","example":"1234"}}],"responses":{"200":{"description":"OK","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/InputStream"}}}},"202":{"description":"No Content","content":{"application/octet-stream":{"schema":{"type":"string","format":"byte"}}}},"401":{"description":"Not authorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"ApiKeyAuth":[]}]}},"/loads/{loadId}/pod/docs/{documentId}":{"get":{"tags":["Get and create proof of delivery (POD) documentation"],"summary":"Download proof of delivery document by document ID","description":"Users from company owner and company sub-contractor have access to this method. Method allows to download proof of delivery document by document ID. Document ID can be received by GET load/{loadId}/pod/docsInfo method.","operationId":"getAssignedLoadPODDocumentByIdUsingGET","parameters":[{"name":"loadId","in":"path","description":"load ID","required":true,"schema":{"type":"integer","format":"int64","example":"1234"}},{"name":"documentId","in":"path","description":"documentId","required":true,"schema":{"type":"integer","format":"int64","example":"12"}}],"responses":{"200":{"description":"OK","content":{"application/octet-stream":{"schema":{"type":"string","format":"byte"}}}},"401":{"description":"Not authorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"ApiKeyAuth":[]}]}},"/loads/{loadId}/pod/docsInfo":{"get":{"tags":["Get and create proof of delivery (POD) documentation"],"summary":"Get proof of delivery documents list associated with booking","description":"Returns proof of delivery documents list associated with booking.\n### Access Control\nallowed users from:\n- owner\n- subcontractor","operationId":"getLoadPODInformationUsingGET","parameters":[{"name":"loadId","in":"path","description":"load ID","required":true,"schema":{"type":"integer","format":"int64","example":"1234"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocInfoDto"},"example":{"attachmentType":"POD","companyId":0,"date":"2022-02-14T12:00:00.000Z","documentType":"string","fileNameExtension":"pdf","id":12345,"name":"document","size":10,"userId":4321}}}},"401":{"description":"Not authorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"ApiKeyAuth":[]}]}},"/loads/{loadId}/docsInfo":{"get":{"tags":["Upload, get, download, and delete load documentation"],"summary":"Get documents list associated with booking","description":"This method returns documents list associated with booking.\n\n ### Access Control\n\n allowed users from:\n\n - owner\n\n - subcontractor ","operationId":"getLoadDocumentInformationUsingGET","parameters":[{"name":"loadId","in":"path","description":"load id","required":true,"schema":{"type":"integer","format":"int64","example":"1234"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DocInfoDto"},"example":[{"name":"Accessorial Approval","id":7611,"date":"2020-11-11T21:43:27.000Z","userId":140953,"companyId":106115,"size":56769,"fileNameExtension":"jpg","attachmentType":"LOAD_DOCUMENT"},{"name":"Accessorial Approval","id":9274,"date":"2021-01-20T17:30:56.000Z","userId":140953,"companyId":106115,"size":6212,"fileNameExtension":"png","attachmentType":"LOAD_DOCUMENT"},{"name":"My Document","id":9275,"date":"2021-01-20T17:37:52.000Z","userId":140953,"companyId":106115,"size":6212,"fileNameExtension":"png","attachmentType":"LOAD_DOCUMENT"},{"name":"My Document","id":9368,"date":"2021-02-08T15:06:00.000Z","userId":140953,"companyId":106115,"size":6212,"fileNameExtension":"png","attachmentType":"LOAD_DOCUMENT"}]}}}},"401":{"description":"Not authorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"ApiKeyAuth":[]}]}},"/load/{loadId}/stops/{stopId}/status":{"get":{"tags":["Manage stop-offs for loads"],"summary":"Get load stop status information","description":"This method returns the status of a specific stop on a specified load.","operationId":"getLoadStopStatusUsingGET","parameters":[{"name":"loadId","in":"path","description":"load ID","required":true,"schema":{"type":"integer","format":"int64","example":"1234"}},{"name":"stopId","in":"path","description":"load stop ID","required":true,"schema":{"type":"integer","format":"int64","example":"2"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoadStopDto"}}}},"401":{"description":"Not authorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"}},"security":[{"ApiKeyAuth":[]}]},"post":{"tags":["Manage stop-offs for loads"],"summary":"Post load stop status","description":"Enables users to update the status of a stop on a specified load.","operationId":"postLoadStopStatusUsingPOST","parameters":[{"name":"loadId","in":"path","description":"load id","required":true,"schema":{"type":"integer","format":"int64","example":"1234"}},{"name":"stopId","in":"path","description":"stop ID","required":true,"schema":{"type":"integer","format":"int64","example":"2"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoadStopStatusDto"}}},"description":"stopDto","required":true},"responses":{"200":{"description":"OK"},"201":{"description":"Created"},"401":{"description":"Not authorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"}},"security":[{"ApiKeyAuth":[]}]}},"/loads/{loadId}/quotes":{"get":{"tags":["Get information about loads"],"summary":"Get load quotes","description":"This method returns quotes for a specific load.","operationId":"getLoadQuotesUsingGET","parameters":[{"name":"loadId","in":"path","description":"load ID","required":true,"schema":{"type":"integer","format":"int64","example":"1234"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuoteInfo"},"example":[{"id":206805,"loadId":1704770,"loadOwnerCompanyId":170801308,"currency":{"code":"GBP","symbol":"£"},"price":544,"quoteStatus":{"status":"POSTED"},"quoteOwner":{"company":{"id":170802070},"user":{"id":147330,"firstName":"John","lastName":"Smith","phone":4412345678900}},"quoteAuthor":{"company":{"id":170802070},"user":{"id":147330,"firstName":"John","lastName":"Smith","phone":4412345678900}},"vehicle":{"id":178834,"vehicleType":{"vehicleTypeApiKey":"M/Van","vehicleTypeSize":40}},"charges":{"waitingTime":15555555555555556,"loadingTime":16666666666666,"cancellation":17777777777777,"other":188888888888888},"accessorials":[],"totalPrice":544,"createdOn":"2022-01-19T08:03:22.000Z","currencyCode":"GBP","status":"POSTED"},{"id":206804,"loadId":1704770,"loadOwnerCompanyId":170801308,"currency":{"code":"GBP","symbol":"£"},"price":1000,"quoteStatus":{"status":"POSTED"},"quoteOwner":{"company":{"id":100},"user":{"id":1074387,"firstName":"Jane","lastName":"Doe","phone":4412345678900}},"quoteAuthor":{"company":{"id":100},"user":{"id":1074387,"firstName":"Jane","lastName":"Doe","phone":4412345678900}},"charges":{"waitingTime":3,"loadingTime":3,"cancellation":3,"other":3},"accessorials":[],"totalPrice":1000,"createdOn":"2022-01-14T16:06:01.000Z","currencyCode":"GBP","status":"POSTED"}]}}},"401":{"description":"Not authorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"}},"security":[{"ApiKeyAuth":[]}]}},"/loadDocTypes":{"get":{"tags":["Upload, get, download, and delete load documentation"],"summary":"Get document types","description":"Returns a list of document types required for couriers to deliver loads for clients. \n \n**Document Types** <table> <thead>\n <tr style=\"background: lightgray\">\n <th>Document Type</th>\n <th>Explanation</th>\n </tr>\n</thead> <tbody>\n <tr>\n <td>Light/Heavy Scale Ticket</td>\n <td>used to keep track of the weight of a truck load. Enables both buyer and seller to have an accurate reading of the weight of the load.</td>\n </tr>\n <tr>\n <td>Proof of Delivery (POD)</td>\n <td>Document that serves as written evidence of the proper delivery of a shipment. </td>\n </tr>\n <tr>\n <td>Delivery Ticket</td>\n <td>Document signed by purchaser on collection of load.</td>\n </tr>\n <tr>\n <td>Rate Confirmation</td>\n <td>Legally binding agreement of pay between the freight broker and carrier. A freight broker must provide a rate confirmation for the carrier to sign before proceeding.</td>\n </tr>\n <tr>\n <td>Accessorial Approval</td>\n <td>An accessorial charge is additional freight fees your shipment can accrue. Accessorials commonly include the need for special equipment and services such as liftgates, non-commercial destinations and inside pickup and/or delivery.</td>\n </tr>\n <tr>\n <td>Bill of Lading (BOL)</td>\n <td>Document of title, a receipt for shipped goods, and a contract between a carrier and shipper.</td>\n </tr>\n <tr>\n <td>Correspondence</td>\n <td>Contains general correspondence between client and carrier</td>\n </tr>\n <tr>\n <td>Lumper Receipt</td>\n <td>Receipt for additional fees incurred if a delivery company uses third party subcontractors</td>\n </tr>\n <tr>\n <td>OS&D Report</td>\n <td>Document listing every detail about the goods that arrived incorrect or damaged. The consignee gets a copy of this report, and so does the driver.</td>\n </tr>\n <tr>\n <td>Freight Damage</td>\n <td>Document inventorying an damage to the load contents. Can be used for making damage claims</td>\n </tr>\n <tr>\n <td>Load Tender</td>\n <td>Document allowing shippers or brokers to offer cargo to multiple carriers in order to secure the best rates available.</td>\n </tr>\n <tr>\n <td>Invoice</td>\n <td>Contains the total bill charged by delivery company for delivering load</td>\n </tr>\n <tr>\n <td>Packing List</td>\n <td>Formal document showing an itemised list of the goods within a shipping package for identification and tallying purposes.</td>\n </tr>\n</tbody> </table>","operationId":"getLoadDocumentTypesUsingGET","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/LocalisedValueDto"},"example":[{"apiKey":"HEAVY_SCALE_TICKET","name":"Heavy Scale Ticket"},{"apiKey":"RATE_CONFIRMATION","name":"Rate Confirmation"},{"apiKey":"LIGHT_SCALE_TICKET","name":"Light Scale Ticket"},{"apiKey":"PACKING_LIST","name":"Packing List"},{"apiKey":"ACCESSORIAL_APPROVAL","name":"Accessorial Approval"},{"apiKey":"BOL","name":"BOL"},{"apiKey":"OTHER","name":"Other"},{"apiKey":"CORRESPONDENCE","name":"Correspondence"},{"apiKey":"LUMPER_RECEIPT","name":"Lumper Receipt"},{"apiKey":"OSD","name":"OS&D (claim handling)"},{"apiKey":"DELIVERY_TICKET","name":"Delivery Ticket"},{"apiKey":"FREIGHT_DAMAGE","name":"Freight Damage"},{"apiKey":"POD","name":"POD"},{"apiKey":"LOAD_TENDER","name":"Load Tender"},{"apiKey":"INVOICE","name":"Invoice"}]}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"ApiKeyAuth":[]}]}},"/loads/{loadId}/stops/{stopId}/docs":{"post":{"tags":["Manage stop-offs for loads"],"summary":"Upload documents for stop-offs","description":"This method enables drivers to upload Proof of Delivery documents, signatures and photos.","operationId":"uploadStopDocumentUsingPOST","parameters":[{"name":"loadId","in":"path","description":"load ID","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"stopId","in":"path","description":"load stop ID","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopDocInfoDto"},"example":{"expireOn":"2030-11-05T13:15:30Z","documentType":"POD","fileDescription":"photo","attached":true,"public":true}}}},"responses":{"200":{"description":"OK"},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"ApiKeyAuth":[]}]}},"/load/{loadId}/currentLocation":{"get":{"tags":["Get information about loads"],"summary":"Get current load location","description":"Users from company owner and company sub-contractor have the ability to receive this data. This method can show the current location of subcontractors for 'in progress' loads.","operationId":"loadCurrentLocationUsingGET","parameters":[{"name":"loadId","in":"path","description":"load ID","required":true,"schema":{"type":"integer","format":"int64","example":"1234"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationDto"},"example":{"latitude":51.5138,"longitude":0.0984,"timestamp":1651653680094,"address":{"country":"GB","town":"London","postcode":"EC4M 8AD","fullAddress":"St. Paul's Churchyard, London EC4M 8AD","coordinates":{"lng":0.0984,"lat":51.5138},"shortDisplayAddress":"London EC4M 8AD"},"status":"UNAVAILABLE","messageId":5,"locationSource":"UNKNOWN","vehicleId":237394}}}},"401":{"description":"Not authorized","content":{"text/plain":{"schema":{"type":"string"},"examples":{"noAuth":{"description":"The load you are trying to access does not belong to your company.","value":"You aren't subscribed to perform this operation. Please, contact your system administrator."}}}}},"403":{"description":"Forbidden","content":{"text/plain":{"schema":{"type":"string"},"examples":{"forbidden":{"description":"The load you are accessing has status `\"COMPLETED\"` or `\"CANCELED\"`","value":"Load is NOT in progress"}}}}},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"type":"string"},"example":{"notFound":{"description":"The load you are accessing is not being tracked","value":"Sub-contractor does NOT have active tracking"}}}}}},"security":[{"ApiKeyAuth":[]}]}},"/loads/matchedRoute":{"get":{"tags":["Get information about loads"],"summary":"Get loads matched to the route","description":"This method returns the loads matched to a specified route.","operationId":"getLoadsMatchedToRouteUsingGET","parameters":[{"name":"startLocation","in":"query","description":"start of route","required":true,"schema":{"$ref":"#/components/schemas/LatLngDto"},"example":"51.5073509, 0.1277582999999822"},{"name":"endLocation","in":"query","description":"end of route","required":true,"schema":{"$ref":"#/components/schemas/LatLngDto"},"example":"53.8007554, -1.5490773999999874"},{"name":"departureTime","in":"query","description":"The date and time the load begins its journey","required":true,"schema":{"type":"string","example":"2022-01-18T13:23:39Z"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/LoadDto"}}}}},"401":{"description":"Not authorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity","content":{"text/plain":{"schema":{"type":"string","example":"At least two points should be provided"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/load/formValues":{"get":{"tags":["Get information about loads"],"summary":"Get load form values","description":"This method returns load form values.","operationId":"getLoadFormValuesUsingGET","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoadFormValuesDto"},"example":{"paymentTerms":[{"apiKey":"COD","name":"COD"},{"apiKey":"7FI","name":"7 Days (From Invoice)"},{"apiKey":"14FI","name":"14 Days (From Invoice)"},{"apiKey":"21FI","name":"21 Days (From Invoice)"},{"apiKey":"30FI","name":"30 Days (From Invoice)"},{"apiKey":"30EOM","name":"30 Days (End Of Month)"},{"apiKey":"45FI","name":"45 Days (From Invoice)"},{"apiKey":"45EOM","name":"45 Days (End Of Month)"},{"apiKey":"60FI","name":"60 Days (From Invoice)"}],"jobDescriptions":[{"apiKey":"SAME_DAY_TIMED","name":"Same Day - Timed"},{"apiKey":"SAME_DAY_NON_TIMED","name":"Same Day - Non Timed"},{"apiKey":"NEXT_DAY_TIMED","name":"Next Day - Timed"},{"apiKey":"NEXT_DAY_NON_TIMED","name":"Next Day - Non Timed"},{"apiKey":"3_5_DAYS","name":"3 - 5 Days"},{"apiKey":"MULTI_DROP","name":"Multi-Drop"},{"apiKey":"DELIVER_DIRECT","name":"Deliver Direct"}],"freightTypes":[{"apiKey":"NA","name":"n/a"},{"apiKey":"AMBIENT","name":"Ambient"},{"apiKey":"ADR","name":"ADR"},{"apiKey":"AIR_FREIGHT_LEVEL_A_B","name":"Level A/B Aviation"},{"apiKey":"AIR_FREIGHT_LEVEL_D","name":"Cargo Operative (prev Level D)"},{"apiKey":"CHILLED","name":"Refrigerated / Chilled"},{"apiKey":"CONTAINER","name":"Container"},{"apiKey":"FOODSTUFFS","name":"Foodstuffs"},{"apiKey":"FORS_BRONZE","name":"FORS Bronze"},{"apiKey":"FORS_SILVER","name":"FORS Silver"},{"apiKey":"FORS_GOLD","name":"FORS Gold"},{"apiKey":"FRAGILE","name":"Fragile"},{"apiKey":"DGSA_QUALIFIED","name":"DGSA Qualified"},{"apiKey":"HANGING_GARMENTS","name":"Hanging Garments"},{"apiKey":"INSTALLATION&SWAPOUT","name":"Installation & Swapout"},{"apiKey":"LIVESTOCK","name":"Livestock"},{"apiKey":"LOOSE","name":"Loose"},{"apiKey":"REMOVALS","name":"Removals"},{"apiKey":"SECURE","name":"High Security"},{"apiKey":"FROZEN","name":"Frozen"},{"apiKey":"WASTE","name":"Waste"},{"apiKey":"WEEE","name":"WEEE"}],"packagings":[{"apiKey":"BAGS","name":"Bags"},{"apiKey":"BALES","name":"Bales"},{"apiKey":"BLANKETS","name":"Blankets"},{"apiKey":"CONTAINERS","name":"Containers"},{"apiKey":"CRATES","name":"Crates"},{"apiKey":"PACKAGES","name":"Packages"},{"apiKey":"PALLETS_EU","name":"Pallets Euro"},{"apiKey":"PALLETS_UK","name":"Pallets UK Standard"},{"apiKey":"STILLAGES","name":"Stillages"},{"apiKey":"ULD","name":"ULD"}],"vehicleTypes":[{"apiKey":"Bike","name":"Motorcycle"},{"apiKey":"Car","name":"Car"},{"apiKey":"S/Van","name":"Small Van"},{"apiKey":"M/Van","name":"Midi Van"},{"apiKey":"SWB","name":"SWB up to 2.4m"},{"apiKey":"Transit","name":"MWB up to 3m"},{"apiKey":"LWB","name":"LWB up to 4m"},{"apiKey":"XLWB","name":"XLWB 4m+"},{"apiKey":"Luton","name":"Luton"},{"apiKey":"7.5T","name":"7.5T"},{"apiKey":"12T","name":"12T"},{"apiKey":"18T","name":"18T"},{"apiKey":"26T","name":"26T"},{"apiKey":"13.6M","name":"13.6M (Arctic)"},{"apiKey":"Skel 1x20","name":"Skellie 1x20ft"},{"apiKey":"Skel 2x20","name":"Skellie 2x20ft"},{"apiKey":"Skel 1x40","name":"Skellie 1x40ft"},{"apiKey":"Skel 1x44","name":"Skellie 1x44ft"},{"apiKey":"4ax Trac","name":"4 Axle Tractor"},{"apiKey":"6ax Trac","name":"6 Axle Tractor"}],"vehicleBodyTypes":[{"apiKey":"NA","name":"n/a"},{"apiKey":"BOX","name":"Box"},{"apiKey":"CURTAIN","name":"Curtain Side"},{"apiKey":"DBLDECK","name":"Double Deck"},{"apiKey":"DROPSIDE","name":"Dropside"},{"apiKey":"FLATBED","name":"Flatbed"},{"apiKey":"HIGHROOF","name":"High Roof"},{"apiKey":"LOWLOADER","name":"Low Loader"},{"apiKey":"PANEL","name":"Panel"},{"apiKey":"REFRIGERATED","name":"Refrigerated"},{"apiKey":"SIDELOADER","name":"Side Loader"},{"apiKey":"TANKER","name":"Tanker"},{"apiKey":"TEMPCONTR","name":"Temperature Controlled"},{"apiKey":"TILT","name":"Tilt"},{"apiKey":"TIPPER","name":"Tipper"},{"apiKey":"TRAILER","name":"Trailer"},{"apiKey":"VEHTRANSP","name":"Vehicle Transporter"}]}}}},"401":{"description":"Not authorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"ApiKeyAuth":[]}]}},"/load/{loadId}/pod":{"get":{"tags":["Get and create proof of delivery (POD) documentation"],"summary":"Get proof of delivery (POD)","description":"Returns proof of delivery by load ID for owner and executor.","operationId":"getPodUsingGET","parameters":[{"name":"loadId","in":"path","description":"load ID","required":true,"schema":{"type":"integer","format":"int64","example":"1234"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PODDto"}}}},"401":{"description":"Not authorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"}},"security":[{"ApiKeyAuth":[]}]},"post":{"tags":["Get and create proof of delivery (POD) documentation"],"summary":"Create proof of delivery","description":"Create proof of delivery and change load status from `\"BOOKED\"` to `\"COMPLETED\"`. Available for owner and executor.","operationId":"completeLoadUsingPOST","parameters":[{"name":"loadId","in":"path","description":"load ID","required":true,"schema":{"type":"integer","format":"int64","example":"1234"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PODDto"}}},"description":"pod","required":true},"responses":{"200":{"description":"OK"},"201":{"description":"Created"},"401":{"description":"Not authorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"}},"security":[{"ApiKeyAuth":[]}]}},"/loads/{loadId}/docs/{documentId}":{"get":{"tags":["Upload, get, download, and delete load documentation"],"summary":"Download document by ID","description":"Method enables users to download a specified document.\n\n### Access Control\nallowed users from:\n- owner\n- subcontractor","operationId":"getAssignedLoadDocumentByIdUsingGET","parameters":[{"name":"loadId","in":"path","description":"load ID","required":true,"schema":{"type":"integer","format":"int64","example":"1234"}},{"name":"documentId","in":"path","description":"documentId","required":true,"schema":{"type":"integer","format":"int64","example":"1"}}],"responses":{"200":{"description":"OK","content":{"application/octet-stream":{"schema":{"type":"string","format":"byte"}}}},"401":{"description":"Not authorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"ApiKeyAuth":[]}]},"delete":{"tags":["Upload, get, download, and delete load documentation"],"summary":"Remove document from load","description":"Users from company owner and company sub-contractor have the ability to remove document assign to load.","operationId":"deleteDocumentAssignedToLoadUsingDELETE","parameters":[{"name":"loadId","in":"path","description":"load id","required":true,"schema":{"type":"integer","format":"int64","example":"1234"}},{"name":"documentId","in":"path","description":"document ID","required":true,"schema":{"type":"integer","format":"int64","example":"3"}}],"responses":{"200":{"description":"OK"},"204":{"description":"No Content"},"401":{"description":"Not authorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"ApiKeyAuth":[]}]}},"/loads/{loadId}/stops/{stopId}/docs/{documentId}":{"get":{"tags":["Manage stop-offs for loads"],"summary":"Get stop document","description":"Method allows users to download proof of delivery and photo from a given stop.","operationId":"getStopDocumentUsingGET","parameters":[{"name":"loadId","in":"path","description":"load id","required":true,"schema":{"type":"integer","format":"int64","example":"1234"}},{"name":"stopId","in":"path","description":"stop ID","required":true,"schema":{"type":"integer","format":"int64","example":"2"}},{"name":"documentId","in":"path","description":"documentId","required":true,"schema":{"type":"integer","format":"int64","example":"3"}}],"responses":{"200":{"description":"OK","content":{"application/octet-stream":{"schema":{"type":"string","format":"byte"}}}},"401":{"description":"Not authorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"}},"security":[{"ApiKeyAuth":[]}]},"delete":{"tags":["Manage stop-offs for loads"],"summary":"Delete stop document","description":"This method enables users to delete a document such as proof of delivery or photo assigned to specified load stop","operationId":"deleteStopDocumentUsingDELETE","parameters":[{"name":"loadId","in":"path","description":"load id","required":true,"schema":{"type":"integer","format":"int64","example":"1234"}},{"name":"stopId","in":"path","description":"stop ID","required":true,"schema":{"type":"integer","format":"int64","example":"1"}},{"name":"documentId","in":"path","description":"document ID","required":true,"schema":{"type":"integer","format":"int64","example":"3"}}],"responses":{"200":{"description":"OK"},"204":{"description":"No Content"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"security":[{"ApiKeyAuth":[]}]}}},"components":{"requestBodies":{"uploadDocumentUsingPOST":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"body":{"description":"body","type":"string","format":"binary"},"docInfoDto":{"description":"docInfoDto","$ref":"#/components/schemas/DocInfoDto"}}}}}}},"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-KEY","description":"TEG recommends using this form of authentication for the API"}},"schemas":{"AccessorialDto":{"type":"object","properties":{"apiKey":{"type":"string","enum":["DETENTION","DRIVER_ASSIST","DRIVER_LOAD","ESCORT","FUEL_SURCHARGE","HAZMAT_CHARGE","LAYOVER_FEE","LUMPER","MISCELLANEOUS_CHARGE","ON_TIME","PERMITS","RE_CONSIGNMENT","RE_WORK","SCALE_TIX","STORAGE","STOP_OFF","TARPING","TEAM_SERVICE","TRUCK_ORDERED","CONGESTION_CHARGE","FERRY_CHARGE","TOLLS","ULEZ"]},"price":{"type":"number","format":"double"}}},"Address":{"type":"object","properties":{"area":{"type":"string"},"building":{"type":"string","maxLength":255},"coordinates":{"$ref":"#/components/schemas/LngLatDto"},"country":{"type":"string","description":"must be one of 3166 2 symbol ISO country codes"},"fullAddress":{"type":"string"},"locality":{"type":"string","maxLength":255},"postcode":{"type":"string","maxLength":10},"route":{"type":"string","maxLength":255},"shortDisplayAddress":{"type":"string"},"streetNumber":{"type":"string","maxLength":255},"town":{"type":"string","maxLength":255}},"required":["coordinates","country"]},"AttachmentInfoDto":{"type":"object","properties":{"attachmentExtId":{"type":"string"},"attachmentType":{"type":"string"},"contentType":{"type":"string"},"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"size":{"type":"integer","format":"int64"}}},"BookingStatusDto":{"type":"object","properties":{"arrivalTime":{"type":"string"},"attachmentsInfo":{"type":"array","items":{"$ref":"#/components/schemas/AttachmentInfoDto"}},"bookingStatus":{"type":"string","enum":["ACCEPTED","DECLINED","EN_ROUTE_TO_PICKUP","ARRIVED_TO_PICKUP","LOADED","ARRIVED_TO_DELIVERY","DELIVERED"]},"loadedInfo":{"$ref":"#/components/schemas/LoadedInfoDto"},"location":{"$ref":"#/components/schemas/LocationDto"},"pod":{"$ref":"#/components/schemas/PODDto"},"statusTime":{"type":"string","example":"2020-10-08T15:11:21.000Z"}},"required":["bookingStatus"]},"ChargesDto":{"type":"object","properties":{"cancellation":{"type":"string"},"loadingTime":{"type":"string"},"other":{"type":"string"},"waitingTime":{"type":"string"}}},"CompanyBriefDto":{"type":"object","properties":{"companyId":{"type":"integer","format":"int64","readOnly":true,"description":"Company ID"},"cxCompanyId":{"type":"string","description":"Company ID with country code"},"name":{"type":"string","description":"Company name"}}},"CompanyLoadsDto":{"type":"object","properties":{"paging":{"type":"array","items":{"$ref":"#/components/schemas/PagingDto"}},"LoadDto":{"type":"object","properties":{"loadId":{"type":"integer","format":"int64"},"createdOn":{"type":"string","format":"date-time"},"status":{"type":"string","enum":["AVAILABLE","UNAVAILABLE","UNKNOWN","MAYBE_AVAILABLE"]}}}}},"CompanyConnectedDriverDto":{"type":"object","properties":{"companyId":{"type":"integer","format":"int64","readOnly":true},"firstName":{"type":"string"},"lastName":{"type":"string"},"vehicles":{"type":"array","items":{"$ref":"#/components/schemas/CompanyConnectedDriverVehicleDto"}}}},"CompanyConnectedDriverFinalDto":{"type":"object","properties":{"companyId":{"type":"integer","format":"int64","readOnly":true},"firstName":{"type":"string"},"lastName":{"type":"string"},"vehicles":{"type":"array","items":{"$ref":"#/components/schemas/CompanyConnectedDriverVehicleFinalDto"}}}},"CompanyConnectedDriverVehicleDto":{"type":"object","properties":{"companyId":{"type":"integer","format":"int64","readOnly":true},"vehReference":{"type":"string"},"vehicleId":{"type":"integer","format":"int64"}}},"CompanyConnectedDriverVehicleFinalDto":{"type":"object","properties":{"vehReference":{"type":"string"},"vehicleId":{"type":"integer","format":"int64"}}},"CompanyDto":{"type":"object","properties":{"about":{"type":"string"},"address1":{"type":"string"},"address2":{"type":"string"},"billingAddress1":{"type":"string"},"billingAddress2":{"type":"string"},"billingContactName":{"type":"string"},"billingCountry":{"type":"string"},"billingEmail":{"type":"string"},"billingPostcode":{"type":"string"},"billingState":{"type":"string"},"billingTown":{"type":"string"},"businessName":{"type":"string"},"changeRequestFields":{"type":"array","items":{"$ref":"#/components/schemas/ProfileChangeRequestFieldDto"}},"companyId":{"type":"integer","format":"int64","readOnly":true},"companyReg":{"type":"string"},"companyTypeId":{"type":"integer","format":"int64"},"companyVehiclesList":{"type":"array","items":{"$ref":"#/components/schemas/VehicleDto"}},"country":{"type":"string"},"countryCode2":{"type":"string"},"displayCompanyId":{"type":"string","readOnly":true},"email":{"type":"string"},"email2":{"type":"string"},"fax":{"type":"string"},"intrastateNo":{"type":"string"},"mainContact":{"type":"string"},"mainContactDepartment":{"type":"string"},"mainContactId":{"type":"integer","format":"int64","readOnly":true},"motorCarrierNo":{"type":"string"},"name":{"type":"string"},"notificationEmail":{"type":"string"},"notificationPhone":{"type":"string"},"operatorsLicense":{"type":"string"},"paymentTerms":{"type":"string"},"phone":{"type":"string"},"phone2":{"type":"string"},"postcode":{"type":"string"},"state":{"type":"string"},"taxId":{"type":"string","readOnly":true},"timeZone":{"type":"string"},"town":{"type":"string"},"tradingName":{"type":"string"},"usdotNumber":{"type":"string"},"vatNumber":{"type":"string"}}},"CompanyEmployeeDriverDto":{"type":"object","properties":{"firstName":{"type":"string","example":"Company"},"lastName":{"type":"string","example":"Driver"},"userId":{"type":"integer","format":"int64","readOnly":true,"example":1074589}}},"CompanyEmployeeDriverFinalDto":{"type":"object","properties":{"firstName":{"type":"string"},"lastName":{"type":"string"},"userId":{"type":"integer","format":"int64","readOnly":true}}},"CompanySubContractorsDto":{"type":"object","properties":{"companyDrivers":{"type":"array","items":{"$ref":"#/components/schemas/CompanyEmployeeDriverDto"},"example":[{"firstName":"John","lastName":"Smith","userId":1074589}]},"connectedDrivers":{"type":"array","items":{"$ref":"#/components/schemas/CompanyConnectedDriverDto"},"example":[{"companyId":170868376,"firstName":"Jane","lastName":"Smith","vehicles":[{"vehicleId":192892,"vehReference":"sub_veh (i)"},{"vehicleId":193160,"vehReference":"sub_alt_veh (i)"}]},{"companyId":170868402,"firstName":"John","lastName":"Smith","vehicles":[{"vehicleId":192920,"vehReference":"VREF"}]}]}}},"CompanySubContractorsFinalDto":{"type":"object","properties":{"companyDrivers":{"type":"array","items":{"$ref":"#/components/schemas/CompanyEmployeeDriverFinalDto"}},"connectedDrivers":{"type":"array","items":{"$ref":"#/components/schemas/CompanyConnectedDriverFinalDto"}}}},"ContactDetailsDto":{"type":"object","properties":{"addressLine1":{"type":"string"},"addressLine2":{"type":"string"},"addressLine3":{"type":"string"},"companyName":{"type":"string"},"contactName":{"type":"string"},"email":{"type":"string"},"notes":{"type":"string"},"phone":{"type":"string"},"postcode":{"type":"string"}}},"ContactDto":{"type":"object","properties":{"companyName":{"type":"string"},"contactName":{"type":"string"},"email":{"type":"string"},"notes":{"type":"string"},"phone":{"type":"string"}}},"ContactsDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ContactDto"}},"paging":{"$ref":"#/components/schemas/PagingDto"}}},"CurrencyDto":{"type":"object","properties":{"code":{"type":"string"},"symbol":{"type":"string"}}},"CurrentLocationDto":{"type":"object","properties":{"availabilityStatus":{"$ref":"#/components/schemas/ExtAvailabilityStatusDto"},"country":{"type":"string"},"latitude":{"type":"number","format":"double"},"longitude":{"type":"number","format":"double"},"postCode":{"type":"string"},"timestamp":{"type":"integer","format":"int64"},"town":{"type":"string"}},"required":["latitude","longitude","timestamp"]},"DocInfoDto":{"type":"object","properties":{"attachmentType":{"type":"string","enum":["POD","SIGNATURE","LOAD_DOCUMENT"]},"companyId":{"type":"integer","format":"int64","readOnly":true},"date":{"type":"string"},"documentType":{"type":"string"},"fileNameExtension":{"type":"string"},"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"size":{"type":"integer","format":"int64"},"userId":{"type":"integer","format":"int64"}}},"EntityCreatedResult":{"type":"object","properties":{"id":{"type":"integer","format":"int64"}}},"EntityDto":{"type":"object","properties":{"id":{"type":"integer","format":"int64"}}},"EventDto":{"type":"object","properties":{"load":{"$ref":"#/components/schemas/LoadStopDto"},"eventType":{"type":"string","enum":["ADD","UPDATE","DELETE"]}}},"ExtAvailabilityStatusDto":{"type":"object","properties":{"message":{"type":"string"},"status":{"type":"string","enum":["AVAILABLE","UNAVAILABLE","UNKNOWN","MAYBE_AVAILABLE"]}},"required":["status"]},"ExtLocationDto":{"type":"object","properties":{"availabilityStatus":{"$ref":"#/components/schemas/ExtAvailabilityStatusDto"},"country":{"type":"string"},"latitude":{"type":"number","format":"double"},"longitude":{"type":"number","format":"double"},"postCode":{"type":"string"},"source":{"type":"string"},"timestamp":{"type":"integer","format":"int64"},"town":{"type":"string"},"vehicleId":{"type":"string"}},"required":["latitude","longitude","timestamp","source"]},"ExtVehicleDto":{"type":"object","properties":{"extReference":{"type":"string"},"extVehicleId":{"type":"string","readOnly":true},"source":{"type":"string"}},"required":["extVehicleId","extReference","source"]},"GroupDto":{"type":"object","properties":{"autoGenerated":{"type":"boolean"},"groupId":{"type":"integer","format":"int64","readOnly":true},"name":{"type":"string"}}},"InputStream":{"type":"object"},"InvoiceDto":{"type":"object","properties":{"createdOn":{"type":"string"},"invoiceDate":{"type":"string"},"paymentDue":{"type":"string"},"simpleInvoicesId":{"type":"integer","format":"int64","readOnly":true}}},"LngLatDto":{"type":"object","properties":{"lat":{"type":"number","format":"double","minimum":-180,"maximum":180},"lng":{"type":"number","format":"double","minimum":-180,"maximum":180}},"required":["lng","lat"]},"LoadChangesDto":{"type":"object","properties":{"authorName":{"type":"string"},"changesTime":{"type":"string"},"value":{"type":"string"}}},"LoadDto":{"type":"object","properties":{"acceptanceRequired":{"type":"boolean"},"attachmentInfo":{"type":"array","items":{"$ref":"#/components/schemas/AttachmentInfoDto"}},"bodyType":{"type":"string","enum":["NA","BOX","CURTAIN","DBLDECK","DROPSIDE","HIGHROOF","LOWLOADER","PANEL","REFRIGERATED","SIDELOADER","TANKER","TEMPCONTR","TILT","TIPPER","TRAILER","VEHTRANSP","CONTAINER","CURTAINSIDE","DOUBLEDROP","FLATBED","POWER","RACKTARP","REEFER","STEPDECK","TRACTORTRAILER","OTHER","STRAIGHT","SPRINTERNA","RGN","CURTAISIDE","CONESTOGA","CARGO","DRYVAN","FRIDGESINGLE","FRIDGEMULTI","FRIDGESPLIT","MEGATRAILER"]},"bookerId":{"type":"integer","format":"int64","readOnly":true},"bookingFooter":{"type":"string"},"bookingStatuses":{"type":"array","items":{"$ref":"#/components/schemas/BookingStatusDto"}},"callbackRequired":{"type":"boolean"},"collectBy":{"type":"string","format":"date-time","example":"2022-01-25T00:00:00Z"},"commodity":{"type":"string"},"createdOn":{"type":"string"},"currency":{"type":"string","enum":["GBP","EUR","PLN","USD"]},"customerAgreedRate":{"type":"number","format":"double","minimum":0,"maximum":999999.99},"customerContactId":{"type":"integer","format":"int64"},"customerReference":{"type":"string","maxLength":30},"deliverBy":{"type":"string","format":"date-time","example":"2022-01-25T00:00:00Z"},"deliverFrom":{"type":"string","format":"date-time","example":"2022-01-25T00:00:00Z"},"deliverTimeRange":{"type":"string","enum":["BETWEEN","AT","BEFORE","ASAP"]},"deliveryTime":{"type":"string","enum":["BETWEEN","AT","BEFORE","ASAP"],"readOnly":true},"distance":{"type":"number","format":"double","readOnly":true},"docInfo":{"type":"array","items":{"$ref":"#/components/schemas/DocInfoDto"}},"draft":{"type":"boolean"},"duration":{"type":"integer","format":"int64","readOnly":true},"enrouteEmail1":{"type":"string"},"enrouteEmail2":{"type":"string"},"enrouteEmail3":{"type":"string"},"eta":{"$ref":"#/components/schemas/LoadEtaDto"},"freightType":{"type":"string","enum":["NA","AMBIENT","ADR","AIR_FREIGHT_LEVEL_A_B","AIR_FREIGHT_LEVEL_D","REFRIGERATED","CONTAINER","FOODSTUFFS","FORS_BRONZE","FORS_SILVER","FORS_GOLD","FRAGILE","DGSA_QUALIFIED","HANGING_GARMENTS","INSTALLATION_AND_SWAPOUT","LIVESTOCK","LOOSE","REMOVALS","SECURE","FROZEN","WASTE","WEEE","GENERAL_CARGO","HAZMAT","CHILLED","AIR_FREIGHT","SAMPLES","CATTLE","SHEEP","PIGS","GOATS","BULK_FEED","BALED_FEED"]},"frequencyForEnrouteEmail":{"type":"integer","format":"int32"},"from":{"$ref":"#/components/schemas/Address"},"fromDisplayAddress":{"type":"string"},"fromShortDisplayAddress":{"type":"string"},"fromTimeZone":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/TimeZoneDto"}]},"fromTimeZoneId":{"type":"string"},"grossWeight":{"$ref":"#/components/schemas/WeightDto"},"groupId":{"type":"integer","format":"int64"},"hiab":{"type":"boolean"},"invoiced":{"type":"boolean"},"jobDescription":{"type":"string"},"jobDisplayDescription":{"type":"string"},"jobDisplayTypeShort":{"type":"string"},"jobType":{"type":"string","enum":["HOTSHOT","BACKLOAD"]},"liftgate":{"type":"boolean"},"loadFieldsChanges":{"$ref":"#/components/schemas/LoadChangesDto"},"loadId":{"type":"integer","format":"int64","readOnly":true},"minVehicleSize":{"type":"string","description":"enum specifying the smallest vehicle needed to transport a load","enum":["Bike","Car","S/Van","M/Van","SWB","Transit","LWB","XLWB","Luton","7.5T","12T","18T","26T","13.6M","Skel 1x20","Skel 2x20","Skel 1x40","Skel 1x44","4ax Trac","6ax Trac","CARGO VLA","CARGO","CAR_PUP","CARGO VSM","SPRINTER","FLATBED","STAKEBED","S_STRAIGHT","L_STRAIGHT","TRACTOR48","TRACTOR53","SUPERB","LOW_BOY","TANK","OTHER","CARGO_V","SPRINTER_C","STR_TRUCK","TRACTOR","BIKE","CAR","CARGO SM","Sprinter","CARGO LA","PUP OP","PUP CL","SUV","FLAT","STAKE","BOX10","BOX12","BOX14","BOX16","BOX18","BOX20","BOX22","BOX24","BOX26","BOX28","BOX30","BOX40","BOX48","BOX53"]},"minVehicleSizeApiKey":{"type":"string"},"moffetMounty":{"type":"boolean"},"notes":{"type":"string","maxLength":1000},"notificationRadius":{"type":"integer","format":"int32"},"numberOfItems":{"type":"integer","format":"int32"},"order":{"$ref":"#/components/schemas/OrderDto"},"ownerCxId":{"type":"string","readOnly":true},"ownerDisplayName":{"type":"string","readOnly":true},"ownerId":{"type":"integer","format":"int64","readOnly":true},"packaging":{"type":"string"},"paymentDisplayTerms":{"type":"string","readOnly":true},"phoneNumber":{"type":"string","maxLength":30},"pickupTime":{"type":"string"},"pickupTimeRange":{"type":"string","enum":["BETWEEN","AT","BEFORE"]},"podHardCopiesRequired":{"type":"boolean"},"postedAt":{"type":"string","format":"date-time","example":"2022-01-25T00:00:00Z","readOnly":true},"quotesEnabled":{"type":"boolean"},"readyAt":{"type":"string","format":"date-time","example":"2022-01-25T00:00:00Z"},"reference":{"type":"string","readOnly":true},"sendEnrouteAccordingGeofence":{"type":"boolean"},"sendEnrouteToMyEmailAddress":{"type":"boolean"},"showCustomerReferenceToSubcontractor":{"type":"boolean"},"showYourReferenceToSubcontractor":{"type":"boolean"},"status":{"type":"string","enum":["POSTED","BOOKED","COMPLETED","CANCELLED"],"readOnly":true},"stops":{"type":"array","items":{"$ref":"#/components/schemas/LoadStopDto"}},"tailLift":{"type":"boolean"},"to":{"$ref":"#/components/schemas/Address"},"toDisplayAddress":{"type":"string","readOnly":true},"toShortDisplayAddress":{"type":"string"},"toTimeZone":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/TimeZoneDto"}]},"toTimeZoneId":{"type":"string"},"trackedDriverPreferred":{"type":"boolean"},"trailer":{"type":"boolean"},"twoMan":{"type":"boolean"},"ulezCrossed":{"type":"boolean"},"vehicleDisplayName":{"type":"string"},"via":{"$ref":"#/components/schemas/Address"},"viaCollectBy":{"type":"string"},"viaDisplayAddress":{"type":"string"},"viaReadyAt":{"type":"string"},"viaShortDisplayAddress":{"type":"string"},"viaTime":{"type":"string"},"viaTimeRange":{"type":"string"},"viaTimeZone":{"$ref":"#/components/schemas/TimeZoneDto"},"viaTimeZoneId":{"type":"string"},"volume":{"$ref":"#/components/schemas/VolumeDto"},"waitAndReturn":{"type":"boolean"},"yourReference":{"type":"string","maxLength":30}},"required":["readyAt","collectBy","from","address","deliverFrom","deliverBy","to","jobDescription","minVehicleSize","freightType"]},"LoadEtaDto":{"type":"object","properties":{"carrierEta":{"type":"string"},"distanceInMiles":{"type":"number","format":"double"},"eta":{"type":"string"},"etaToPickup":{"type":"string"},"executorCompanyId":{"type":"integer","format":"int32"},"loadId":{"type":"integer","format":"int32"},"originalEta":{"type":"string"},"ownerCompanyId":{"type":"integer","format":"int32"},"trackedAt":{"type":"string"}}},"LoadFormValuesDto":{"type":"object","properties":{"freightTypes":{"type":"array","items":{"$ref":"#/components/schemas/LocalisedValueDto"}},"jobDescriptions":{"type":"array","items":{"$ref":"#/components/schemas/LocalisedValueDto"}},"packagings":{"type":"array","items":{"$ref":"#/components/schemas/LocalisedValueDto"}},"paymentTerms":{"type":"array","items":{"$ref":"#/components/schemas/LocalisedValueDto"}},"vehicleBodyTypes":{"type":"array","items":{"$ref":"#/components/schemas/LocalisedValueDto"}},"vehicleTypes":{"type":"array","items":{"$ref":"#/components/schemas/LocalisedValueDto"}}}},"LoadStopDto":{"type":"object","properties":{"address":{"$ref":"#/components/schemas/Address"},"attachmentInfo":{"type":"array","items":{"$ref":"#/components/schemas/AttachmentInfoDto"}},"contact":{"$ref":"#/components/schemas/ContactDto"},"displayAddress":{"type":"string"},"id":{"type":"integer","format":"int64"},"locality":{"type":"string","readOnly":true},"notes":{"type":"string"},"ownerNotes":{"type":"string"},"pod":{"$ref":"#/components/schemas/PODDto"},"premise":{"type":"string"},"shortDisplayAddress":{"type":"string"},"signatureAttachment":{"$ref":"#/components/schemas/AttachmentInfoDto"},"status":{"type":"string"},"statusTime":{"type":"string"},"stopDisplayTime":{"type":"string"},"stopOrder":{"type":"integer","format":"int64","minLength":1,"maxLength":10},"stopStatuses":{"type":"array","items":{"$ref":"#/components/schemas/LoadStopStatusDto"}},"timeFrom":{"type":"string","format":"date-time","example":"2022-01-25T00:00:00Z"},"timeRange":{"type":"string"},"timeTo":{"type":"string","format":"date-time","example":"2022-01-25T00:00:00Z"},"timeZoneName":{"type":"string"},"type":{"type":"string"}},"required":["timeFrom","timeTo"]},"LoadStopStatusDto":{"type":"object","properties":{"attachmentsInfo":{"type":"array","items":{"$ref":"#/components/schemas/AttachmentInfoDto"}},"id":{"type":"integer","format":"int64"},"loadedInfo":{"$ref":"#/components/schemas/LoadedInfoDto"},"notes":{"type":"string"},"pod":{"$ref":"#/components/schemas/PODDto"},"status":{"type":"string"},"statusTime":{"type":"string"}}},"LoadedInfoDto":{"type":"object","properties":{"customerRef":{"type":"string","example":"CREF"},"eta":{"type":"string","example":"2020-10-10T15:10:00.000Z"},"noOfItems":{"type":"integer","format":"int32","example":3333},"notes":{"type":"string","example":"asdfasdfasdf"},"ourRef":{"type":"string","example":"YREF"},"packagingInfo":{"type":"array","items":{"$ref":"#/components/schemas/PackagingInfoDto"}},"ref":{"type":"string"},"weight":{"type":"number","format":"double"},"weightUnit":{"type":"string","enum":["kg","t","lbs"]},"yourRef":{"type":"string","example":"YREF"}}},"LocalisedValueDto":{"type":"object","properties":{"apiKey":{"type":"string"},"name":{"type":"string"}}},"LocationDto":{"type":"object","properties":{"accuracy":{"type":"number","format":"double"},"address":{"$ref":"#/components/schemas/Address"},"latitude":{"type":"number","format":"double"},"locationSource":{"type":"string","enum":["GPS","NETWORK","UNKNOWN","WEB_CLIENT","NAVMAN","TOMTOM","FLEETMATICS","TELEMATICS","QUARTIX","CAUSEWAY","MASTERNAUT","AD_HOC_WEB","MICROLISE","FLEETBOARD","AMS","APEX","GPS_BUDDY","EUROPETRACK","ABAX","T3","RITASSIST","PUBLIC_API","CTRACK","MANDATA","KINESIS","TELL","RAM"]},"longitude":{"type":"number","format":"double"},"messageId":{"type":"integer","format":"int64"},"messageText":{"type":"string"},"status":{"type":"string"},"timestamp":{"type":"integer","format":"int64"},"vehicleId":{"type":"integer","format":"int64"}}},"LocationsDto":{"type":"object","properties":{"locations":{"type":"array","items":{"$ref":"#/components/schemas/LocationDto"}}}},"LatLngDto":{"type":"object","properties":{"lat":{"type":"number","format":"double"},"lng":{"type":"number","format":"double"}}},"OrderDetailsDto":{"type":"object","properties":{"agreedRate":{"type":"number","format":"double"},"enrouteEmailToSubcontractor":{"type":"boolean"},"notes":{"type":"string"},"paymentTerm":{"type":"string","enum":["COD","7FI","14FI","30FI","30EOM","45FI","45EOM","60FI","90FI","90EOM","NET7","NET15","NET30"]},"subcontractor":{"type":"integer","format":"int64"}}},"OrderDto":{"type":"object","properties":{"accessorials":{"type":"array","items":{"$ref":"#/components/schemas/AccessorialDto"}},"agreedRate":{"type":"number","format":"double"},"billingAddress1":{"type":"string"},"billingAddress2":{"type":"string"},"billingCountry":{"type":"string"},"billingEmail":{"type":"string"},"billingName":{"type":"string"},"billingPhone":{"type":"string"},"billingPostcode":{"type":"string"},"billingState":{"type":"string"},"billingTown":{"type":"string"},"collection":{"$ref":"#/components/schemas/ContactDetailsDto"},"customerInvoice":{"$ref":"#/components/schemas/InvoiceDto"},"delivery":{"$ref":"#/components/schemas/ContactDetailsDto"},"driverPhoneNumber":{"type":"string"},"executorTrailerId":{"type":"integer","format":"int64"},"executorUserId":{"type":"integer","format":"int64"},"executorVehicleId":{"type":"integer","format":"int64"},"invoice":{"$ref":"#/components/schemas/InvoiceDto"},"paymentTerm":{"type":"string","enum":["COD","7FI","14FI","30FI","30EOM","45FI","45EOM","60FI","90FI","90EOM","NET7","NET15","NET30"]},"pod":{"$ref":"#/components/schemas/PODDto"},"subcontractorDisplayCompanyId":{"type":"string"},"subcontractorEmail":{"type":"string"},"subcontractorId":{"type":"integer","format":"int64"},"subcontractorName":{"type":"string"},"subcontractorPhone":{"type":"string"},"totalPrice":{"type":"number","format":"double"},"via":{"$ref":"#/components/schemas/ContactDetailsDto"}},"required":["subContractorId","executorUserId","executorVehicleId","driverPhoneNumber","agreedRate","paymentTerm"]},"PODDto":{"type":"object","properties":{"deliveredOn":{"type":"string","example":"2020-10-08T15:15:00.000Z"},"deliveryStatus":{"type":"string","enum":["COMPLETED","BUSINESS_CLOSED","INCORRECT_ADDRESS","CANCELLED","REFUSED","NO_UNLOADING","DAMAGED_GOODS","INCORRECT_GOODS","OTHER"],"example":"COMPLETED"},"deliveryTimeZone":{"type":"string"},"leftAt":{"type":"string","example":"RECEIVING_DEPARTMENT","enum":["RECEIVING_DEPARTMENT","RECEPTION","FRONT_DOOR","BACK_DOOR","SIDE_DOOR","SECURITY","NEIGHBOUR","NOT_DELIVERED","OTHER"]},"noOfItems":{"type":"integer","format":"int32","example":3333},"notes":{"type":"string","example":"asdfasdf"},"packagingInfo":{"type":"array","items":{"$ref":"#/components/schemas/PackagingInfoDto"}},"receivedBy":{"type":"string","example":"RECEIVER"},"released":{"type":"boolean","example":false},"weight":{"type":"number","format":"double","example":333333},"weightUnit":{"type":"string","enum":["kg","t","lbs"],"example":"kg"}}},"PackagingInfoDto":{"type":"object","properties":{"numberOfItems":{"type":"integer","format":"int32"},"packaging":{"type":"string","enum":["BAGS","BALES","BLANKETS","CONTAINERS","CRATES","PACKAGES","PALLETS_US","PALLETS_UK","PALLETS_EU","STILLAGES","ULD","BARRELS","PIECES","RACKS","PIECES","TOTES","TUBS","SKIDS"]}}},"PagingDto":{"type":"object","properties":{"total":{"type":"integer","format":"int32"}}},"PlannedGeofenceVisitBriefDto":{"type":"object","properties":{"vehicleIntRef":{"type":"string"},"bookingRef":{"type":"string"},"shedCode":{"type":"string"},"plannedDispatchDate":{"type":"string"},"estimatedArrivalDate":{"type":"string"}}},"ProfileChangeRequestFieldDto":{"type":"object","properties":{"newValue":{"type":"string"},"oldValue":{"type":"string"},"profileModeratedFieldName":{"type":"string"}}},"QuoteInfo":{"type":"object","properties":{"accessorials":{"type":"array","items":{"$ref":"#/components/schemas/AccessorialDto"}},"charges":{"$ref":"#/components/schemas/ChargesDto"},"createdOn":{"type":"string","example":"yyyy-MM-dd'T'HH:mm:ss'Z'"},"currency":{"$ref":"#/components/schemas/CurrencyDto"},"currencyCode":{"type":"string"},"distanceToPickup":{"type":"number","format":"double"},"id":{"type":"integer","format":"int64"},"loadId":{"type":"integer","format":"int64"},"loadOwnerCompanyId":{"type":"integer","format":"int64"},"notes":{"type":"string"},"pickUpWithin":{"type":"integer","format":"int32"},"price":{"type":"number","format":"double"},"quoteAuthor":{"$ref":"#/components/schemas/UserDto"},"quoteOwner":{"$ref":"#/components/schemas/UserDto"},"quoteStatus":{"$ref":"#/components/schemas/QuoteStatusDto"},"status":{"type":"string","enum":["ACCEPTED","POSTED","DISMISSED","CANCELLED"]},"totalPrice":{"type":"number","format":"double"},"vehicle":{"$ref":"#/components/schemas/VehicleDto"}}},"QuoteStatusDto":{"type":"object","properties":{"status":{"type":"string","enum":["ACCEPTED","POSTED","DISMISSED","CANCELLED"]}},"required":["status"]},"ReassingLoadToOwnDriverDto":{"type":"object","properties":{"userId":{"type":"integer","format":"int64"},"vehicleId":{"type":"integer","format":"int64"}}},"ResponseEntity":{"type":"object","properties":{"body":{"type":"object"},"statusCode":{"type":"string","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,418,419,420,421,422,423,424,426,428,429,431,500,501,502,503,504,505,506,507,508,509,510,511]}}},"SearchContact":{"type":"object","properties":{"companyId":{"type":"integer","format":"int64"},"companyName":{"type":"string"},"contactType":{"type":"string","enum":["COMPANY"]},"cxId":{"type":"string"},"id":{"type":"integer","format":"int64"},"name":{"type":"string"}}},"StopDocInfoDto":{"type":"object","properties":{"documentType":{"type":"string"},"name":{"type":"string"},"attachmentType":{"type":"string"},"id":{"type":"integer","format":"int64"},"date":{"type":"string"},"userId":{"type":"integer","format":"int64"},"fileNameExtension":{"type":"string"}}},"SubcontractorInfoDto":{"type":"object","properties":{"driverPhoneNumber":{"type":"string"},"subcontractorId":{"type":"integer","format":"int64"}}},"TimeZoneDto":{"type":"object","properties":{"name":{"type":"string"},"shortName":{"type":"string"},"timeZone":{"type":"string","enum":["US_Aleutian","US_Hawaii","US_Alaska","US_Pacific","US_Arizona","US_Mountain","US_Central","US_Eastern","Canada_Atlantic","Canada_Central","Canada_Eastern","Canada_Mountain","Canada_Newfoundland","Canada_Pacific","Canada_Yukon","Canada_Saskatchewan","America_Dawson_Creek","America_Atikokan","America_Blanc_Sablon","WET","EET","CET","GMT","Asia_Almaty","Asia_Baku","Asia_Oral","Europe_Moscow","Europe_London"]}}},"UserDto":{"type":"object","properties":{"companyId":{"type":"integer","format":"int64"},"companyName":{"type":"string"},"countryCode":{"type":"string"},"countryName":{"type":"string"},"cxId":{"type":"string"},"department":{"type":"string"},"departmentId":{"type":"integer","format":"int64"},"email":{"type":"string"},"firstName":{"type":"string"},"hasProfilePicture":{"type":"boolean"},"ifexTags":{"type":"array","items":{"type":"string"}},"isAdmin":{"type":"boolean"},"isCx":{"type":"boolean"},"isIfex":{"type":"boolean"},"jobTitle":{"type":"string"},"lastName":{"type":"string"},"password":{"type":"string"},"phone1":{"type":"string"},"phone2":{"type":"string"},"role":{"type":"string"},"timeZone":{"type":"string"},"userId":{"type":"integer","format":"int64"},"username":{"type":"string"}}},"UserEntityDto":{"type":"object","properties":{"firstName":{"type":"string"},"id":{"type":"integer","format":"int64"},"lastName":{"type":"string"},"phone":{"type":"string"}}},"VehicleDto":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"vehicleType":{"$ref":"#/components/schemas/VehicleTypeDto"}}},"VehicleTypeDto":{"type":"object","properties":{"vehicleTypeApiKey":{"type":"string"},"vehicleTypeSize":{"type":"integer","format":"int32"}}},"VehiclesDto":{"type":"object","properties":{"vehicles":{"type":"array","items":{"$ref":"#/components/schemas/VehicleDto"}}}},"VersionDto":{"type":"object","properties":{"protocolVersion":{"type":"string"},"version":{"type":"string"}}},"VolumeDto":{"type":"object","properties":{"height":{"type":"number","format":"double"},"length":{"type":"number","format":"double"},"unit":{"$ref":"#/components/schemas/LocalisedValueDto"},"units":{"type":"string"},"width":{"type":"number","format":"double"}}},"WebhookUrlDto":{"type":"object","properties":{"eventType":{"type":"string","enum":["LOAD_BOOKING_STATUS","STOPS","LOAD_QUOTE","LOAD_DOCUMENT","LOAD_ETA_STATUS","VEHICLE_TRACKING","LOAD"]},"url":{"type":"string"}},"required":["eventType","url"]},"WeightDto":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/LocalisedValueDto"},"units":{"type":"string"},"value":{"type":"number","format":"double"}}}}},"tags":[{"name":"Create, return, update, and delete loads","description":"These methods handle create, return, update, and delete (CRUD) operations for loads."},{"name":"Confirm load bookings and update their status","description":"Methods for confirming booking and setting the booking status for a load."},{"name":"Get information about loads","description":"Methods to retrieve information about a load including the booking status, quotes, location, route and load form values."},{"name":"Get and create proof of delivery (POD) documentation","description":"Proof of delivery documents are essential to validate that a company has delivered a load as required. These methods allow users to create PODs, along with retrieving POD documents and signatures."},{"name":"Upload, get, download, and delete load documentation","description":"Couriers delivering goods are required to possess a number of key documents. These allow couriers to validate how much their vehicle can carry, what items they are delivering, and whether or not their freight has been damaged. Our API contains methods to make it as easy as possible to add and remove documents as required, conforming with the legal standards of the haulage industry."},{"name":"Assign loads","description":"Methods for assigning loads to a vehicle or subcontractor."},{"name":"Manage stop-offs for loads","description":"Sometimes drivers have to make stop-offs to pick up or deliver specific items. TEG's API allows users to add stops to loads, as well as viewing and uploading a proof of delivery and a photo for each stop."}],"x-readme":{"explorer-enabled":true,"proxy-enabled":true}}