{"openapi":"3.0.3","info":{"title":"Companies","description":"Manage companies 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":{"/companyInfo":{"get":{"tags":["Get company brief information"],"summary":"Company brief by email","description":"This method is used for receiving a company ID by email. After receiving the company ID, use it for assigning loads.","operationId":"getCompanyInfoUsingGET","parameters":[{"name":"email","in":"query","description":"Company email","required":true,"schema":{"type":"string","example":"email@company.com"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyBriefDto"},"example":{"name":"Truckers Inc","companyId":106115,"cxCompanyId":"GB106115"}}}},"401":{"description":"Not authorized"},"403":{"description":"Forbidden"},"404":{"description":"Not found"}},"security":[{"ApiKeyAuth":[]}]}},"/company/subContractors":{"get":{"tags":["Get company contact information"],"summary":"Get company sub-contractors","description":"This method returns the company sub-contractors.","operationId":"getOwnCompanySubContractorsUsingGET","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanySubContractorsDto"}}}},"401":{"description":"Not authorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"ApiKeyAuth":[]}]}},"/company/{companyId}/drivers":{"get":{"tags":["Get company vehicle information"],"summary":"Get company drivers","description":"This method returns users from your own company with the 'Driver' permission.","operationId":"getCompanyDriversUsingGET","parameters":[{"name":"companyId","in":"path","description":"company ID","required":true,"schema":{"type":"integer","format":"int64","example":"1002"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UserDto"}},"example":[{"userId":1074545,"companyId":106115,"firstName":"John","lastName":"Smith","phone1":4412345678900,"email":"john.smith@example.com","timeZone":"WET","isAdmin":false,"jobTitle":null,"cxId":"GB 106115-403","companyName":"Truckers Inc"},{"userId":1074589,"companyId":106115,"firstName":"Jane","lastName":"Doe","phone1":4412345678900,"email":"jane.doe@example.com","timeZone":"WET","isAdmin":false,"jobTitle":null,"cxId":"GB 106115-407","companyName":"Truckers Inc"}]}}},"401":{"description":"Not authorized"},"403":{"description":"Forbidden"},"404":{"description":"Not found"}},"security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}]}},"/company/{companyId}/vehicles":{"get":{"tags":["Get company vehicle information"],"summary":"Get company vehicles","description":"This method returns company vehicles.","operationId":"getCompanyVehiclesUsingGET","parameters":[{"name":"companyId","in":"path","description":"company ID","required":true,"schema":{"type":"integer","format":"int64","example":"1002"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VehiclesDto"},"example":{"vehicles":[{"vehicleId":192844,"size":"Bike","bodyType":"NA","reference":"ABAX"},{"vehicleId":192846,"size":"Bike","bodyType":"NA","reference":"ABAX2"},{"vehicleId":192848,"size":"Bike","bodyType":"NA","reference":"ABAX 3"},{"vehicleId":192850,"size":"Bike","bodyType":"NA","reference":"ABAX 4"},{"vehicleId":192854,"size":"Bike","bodyType":"NA","reference":"ABAX 6"},{"vehicleId":192856,"size":"Bike","bodyType":"NA","reference":2222222},{"vehicleId":192858,"size":"Bike","bodyType":"NA","reference":"ABAX LAST"},{"vehicleId":192860,"size":"Bike","bodyType":"NA","reference":"ABAX LAST 2"},{"vehicleId":192862,"size":"Bike","bodyType":"NA","reference":"ABANDREY"},{"vehicleId":192864,"size":"Bike","bodyType":"NA","reference":"KV16 WZT"},{"vehicleId":192876,"size":"Bike","bodyType":"NA","reference":"KV16 WZT"},{"vehicleId":192906,"size":"Bike","bodyType":"NA","reference":"VOLVO"},{"vehicleId":192908,"size":"Bike","bodyType":"NA","reference":"MAN"},{"vehicleId":192910,"size":"Bike","bodyType":"NA","reference":"TOMTOM"},{"vehicleId":192912,"size":"Bike","bodyType":"NA","reference":"navman1"},{"vehicleId":192914,"size":"Bike","bodyType":"NA","reference":"navman2"},{"vehicleId":192916,"size":"Bike","bodyType":"NA","reference":"navman3"},{"vehicleId":193162,"size":"Bike","bodyType":"NA","reference":"MAN"},{"vehicleId":192834,"size":"Bike","bodyType":"NA","reference":"MAN2"}]}}}},"401":{"description":"Not authorized"},"403":{"description":"Forbidden"},"404":{"description":"Not found"}},"security":[{"ApiKeyAuth":[]}]}},"/company/adhoc":{"get":{"tags":["Get company brief information"],"summary":"Get company brief by email and phone","description":"Use this method to find a company by `email` or `phone`. At least one parameter must be provided in the querystring.","operationId":"getCompanyAdhocUsingGET","parameters":[{"name":"phone","in":"query","description":"phone number","required":false,"schema":{"type":"string","example":"0123 4567"}},{"name":"email","in":"query","description":"email","required":false,"schema":{"type":"string","example":"email@company.com"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyBriefDto"},"example":{"name":"Ad Hoc (292) 808-7421","companyId":170800710,"cxCompanyId":"US170800710"}}}},"401":{"description":"Not authorized"},"403":{"description":"Forbidden"},"404":{"description":"Not found"},"422":{"description":"Unprocessable Entity","content":{"text/plain":{"schema":{"type":"string"},"examples":{"missingParams":{"description":"Query parameters are missing from URL.","value":"\"Either phone or email must be set\""}}}}}},"security":[{"ApiKeyAuth":[]}]}},"/company/{companyId}/currentLocations":{"get":{"tags":["Get company vehicle information"],"summary":"Get the current location of company vehicles","operationId":"getCurrentLocationsUsingGET","parameters":[{"name":"companyId","in":"path","description":"company ID","required":true,"schema":{"type":"integer","format":"int64","example":"1002"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationsDto"}}}},"401":{"description":"Not authorized"},"403":{"description":"Forbidden"},"404":{"description":"Not found"}},"security":[{"ApiKeyAuth":[]}]}},"/companyBrief/{companyId}":{"get":{"tags":["Get company brief information"],"summary":"Get company brief by company ID","description":"This method returns company brief given the company ID as a path parameter.","operationId":"getCompanyBriefUsingGET","parameters":[{"name":"companyId","in":"path","description":"Company ID","required":true,"schema":{"type":"integer","format":"int64","example":"1002"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyBriefDto"},"example":{"name":"Truckers Inc","companyId":106115,"cxCompanyId":"GB106115"}}}},"401":{"description":"Not authorized"},"403":{"description":"Forbidden"},"404":{"description":"Not found"}},"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":"Specifies the smallest vehicle that is required 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":"Get company contact information","description":"Methods for retrieving company contact information including subcontractors."},{"name":"Get company vehicle information","description":"Methods for retrieving company information about vehicles and associated loads."},{"name":"Get company brief information","description":"The company brief contains the company name, company ID and Courier Exchange ID. These methods retrieve company brief information by providing the email, the email and phone number, or company ID."}],"x-readme":{"explorer-enabled":true,"proxy-enabled":true}}