{"openapi":"3.0.0","x-samples-languages":["curl","javascript","node","java","kotlin","python","php","go","swift"],"info":{"description":"The Onboarding API allow you to onboard resources within the Karhoo Platform.","version":"v1.0","title":"Onboarding API","contact":{"email":"api@karhoo.com"},"x-hugo-values":{"tags":["api"],"categories":["onboarding"],"public":false}},"paths":{"/fleet":{"post":{"tags":["Create Fleet"],"summary":"Configure a new fleet","description":"Configure a new fleet","requestBody":{"$ref":"#/components/requestBodies/Fleet"},"responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Fleet"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized. Invalid credentials provided"},"403":{"description":"Forbidden. The credentials provided do not have sufficient authority for this request"}},"security":[{"Bearer":[]}]},"get":{"tags":["Get Fleets"],"summary":"Get a list of all hosted fleets","description":"Provides an array of all fleets integrated in the Karhoo platform","parameters":[{"in":"query","name":"offset","description":"Pagination offset","required":false,"schema":{"type":"string"}},{"in":"query","name":"limit","description":"Pagination limit","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FleetArray"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized. Invalid credentials provided"},"403":{"description":"Forbidden. The credentials provided do not have sufficient authority for this request"}},"security":[{"Bearer":[]}]}},"/fleet/search":{"get":{"tags":["Fleet Search"],"summary":"Search through all configured fleets","parameters":[{"in":"query","name":"offset","description":"Pagination offset","required":false,"schema":{"type":"string"}},{"in":"query","name":"limit","description":"Pagination limit","required":false,"schema":{"type":"string"}},{"in":"query","name":"search_term","description":"free form search parameter for filtering an organisations users","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FleetMinArray"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized. Invalid credentials provided"},"403":{"description":"Forbidden. The credentials provided do not have sufficient authority\nfor this request\n"}},"security":[{"Bearer":[]}]},"post":{"tags":["Fleet Search"],"summary":"Search through all configured fleets. Support advanced filtering opitions.\n","parameters":[{"in":"query","name":"offset","description":"Pagination offset","required":false,"schema":{"type":"string"}},{"in":"query","name":"limit","description":"Pagination limit","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FleetFilterRequest"}}},"description":"fleet filtering criteria"},"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FleetMinArray"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized. Invalid credentials provided"},"403":{"description":"Forbidden. The credentials provided do not have sufficient authority\nfor this request\n"}},"security":[{"Bearer":[]}]}},"/fleet/labels":{"get":{"description":"Retrieve list of available fleet labels","operationId":"listFleetLabels","tags":["Fleet Labels"],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FleetLabels"}}}},"401":{"description":"Unauthorized. Invalid credentials provided"},"403":{"description":"Forbidden. The credentials provided do not have sufficient authority for this request"}},"security":[{"Bearer":[]}]},"post":{"operationId":"createFleetLabel","tags":["Fleet Labels"],"summary":"Create labels.","description":"Create a new fleet label.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FleetLabel"}}},"description":"request body","required":true},"responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","example":{}}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized. Invalid credentials provided"},"403":{"description":"Forbidden. The credentials provided do not have sufficient authority for this request"}},"security":[{"Bearer":[]}]}},"/fleet/capabilities":{"get":{"tags":["Retrieve list of available fleet capabilities"],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FleetCapabilityList"}}}},"401":{"description":"Unauthorized. Invalid credentials provided"},"403":{"description":"Forbidden. The credentials provided do not have sufficient authority for this request"}}}},"/fleet/fee-uplift-methods":{"get":{"tags":["Retrieve list of available fee uplift computation methods"],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FeeUpliftComputation"}}}},"403":{"description":"Forbidden. The credentials provided do not have sufficient authority for this request"}}}},"/fleet/fare-configuration":{"get":{"tags":["Retrieves country based Fleet Fare Configuration"],"summary":"Retrieves country based fleet fare configuration","description":"Gets country based fleet fare configuration","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CountryFleetFareConfiguration"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized. Invalid credentials provided"},"403":{"description":"Forbidden. The credentials provided do not have sufficient authority for this request"}},"security":[{"Bearer":[]}]}},"/fleet/fare-configuration/{country_code}":{"post":{"tags":["Create/update country based Fleet Fare Configuration"],"summary":"Create or update country based fleet fare configuration","description":"Create or update country based fleet fare configuration","parameters":[{"in":"path","name":"country_code","description":"Country code","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FleetTypeFareConfigurations"}}},"description":"request body","required":true},"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FleetTypeFareConfigurations"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized. Invalid credentials provided"},"403":{"description":"Forbidden. The credentials provided do not have sufficient authority for this request"}},"security":[{"Bearer":[]}]}},"/fleet/{fleet_id}":{"get":{"tags":["Get Fleet By ID"],"summary":"Get a particular fleet using its ID","parameters":[{"in":"path","name":"fleet_id","description":"The Karhoo Fleet Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Fleet"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized. Invalid credentials provided"},"403":{"description":"Forbidden. The credentials provided do not have sufficient authority for this request"}},"security":[{"Bearer":[]}]},"put":{"tags":["Update Fleet"],"summary":"Update an existing Fleet","description":"Update Fleet","parameters":[{"in":"path","name":"fleet_id","description":"The Karhoo Fleet Id","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/Fleet"},"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Fleet"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized. Invalid credentials provided"},"403":{"description":"Forbidden. The credentials provided do not have sufficient authority for this request"}},"security":[{"Bearer":[]}]}},"/fleet/{fleet_id}/external-accounts":{"get":{"operationId":"listExternalAccounts","tags":["Fleet External Accounts"],"summary":"List fleet's external accounts","description":"List fleet's external accounts","parameters":[{"in":"path","name":"fleet_id","description":"The Karhoo Fleet Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FleetExternalAccountsResponse"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized. Invalid credentials provided"},"403":{"description":"Forbidden. The credentials provided do not have sufficient authority for this request"}},"security":[{"Bearer":[]}]},"post":{"operationId":"createExternalAccount","tags":["Fleet External Accounts"],"summary":"Create a new fleet external account","description":"Create a new fleet external account","parameters":[{"in":"path","name":"fleet_id","description":"The Karhoo Fleet Id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FleetExternalAccountSpec"}}},"description":"request body","required":true},"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FleetExternalAccount"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized. Invalid credentials provided"},"403":{"description":"Forbidden. The credentials provided do not have sufficient authority for this request"}},"security":[{"Bearer":[]}]}},"/fleet/{fleet_id}/coverages":{"get":{"tags":["Get Fleet Coverage Areas"],"summary":"Get Fleet coverage areas","description":"Returns coverage areas in GeoJSON format","parameters":[{"name":"fleet_id","in":"path","description":"The Karhoo Fleet Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GeometryCollection"}}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized. Invalid credentials provided"},"403":{"description":"Forbidden. The credentials provided do not have sufficient authority for this request"}},"security":[{"Bearer":[]}]},"post":{"tags":["Map Coverage Areas to Fleet"],"summary":"Map Coverage Areas","description":"Links Coverage Areas to a Fleet","parameters":[{"name":"fleet_id","in":"path","description":"The Karhoo Fleet Id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateFleetCoverageMappingRequest"}}},"description":"request body","required":true},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GeometryCollection"}}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized. Invalid credentials provided"},"403":{"description":"Forbidden. The credentials provided do not have sufficient authority for this request"}},"security":[{"Bearer":[]}]}},"/fleet/{fleet_id}/vehicle-mapping":{"put":{"tags":["Fleet Vehicle Mapping"],"summary":"Update Fleet Vehicle Mappings","description":"Vehicle Mappings enables the Karhoo platform to transform the DMS id's for it's vehicle types to a common Karhoo vehicle class","parameters":[{"name":"fleet_id","in":"path","description":"The Karhoo Fleet Id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateFleetVehicleMappingRequest"}}},"description":"request body","required":true},"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Fleet"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized. Invalid credentials provided"},"403":{"description":"Forbidden. The credentials provided do not have sufficient authority for this request"}},"security":[{"Bearer":[]}]}},"/fleet/{fleet_id}/labels":{"post":{"operationId":"addFleetLabel","tags":["Fleet Labels"],"summary":"Labels selected fleet.","description":"Add a new fleet label to the fleet.","parameters":[{"name":"fleet_id","in":"path","description":"The Karhoo Fleet Id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddFleetLabelRequest"}}},"description":"request body","required":true},"responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","example":{}}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized. Invalid credentials provided"},"403":{"description":"Forbidden. The credentials provided do not have sufficient authority for this request"}},"security":[{"Bearer":[]}]}},"/fleet/{fleet_id}/labels/{label}":{"delete":{"operationId":"removeFleetLabel","tags":["Fleet Labels"],"summary":"Removes a label from selected fleet.","description":"Removes an existing label from the fleet.","parameters":[{"name":"fleet_id","in":"path","description":"The Karhoo Fleet Id","required":true,"schema":{"type":"string"}},{"name":"label","in":"path","description":"The fleet label","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Success response (No content)"},"401":{"description":"Unauthorized. Invalid credentials provided"},"403":{"description":"Forbidden. The credentials provided do not have sufficient authority for this request"},"404":{"description":"Not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"Bearer":[]}]}},"/dispatch":{"get":{"tags":["Get Dispatch Platforms"],"summary":"Get Dispatch Platforms","description":"Get Dispatch Platforms","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DispatchArray"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized. Invalid credentials provided"},"403":{"description":"Forbidden. The credentials provided do not have sufficient authority for this request"}},"security":[{"Bearer":[]}]},"post":{"tags":["Create dispatch Platform"],"summary":"Create dispatch Platform","description":"Create dispatch Platform","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dispatch"}}},"description":"request body","required":true},"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dispatch"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized. Invalid credentials provided"},"403":{"description":"Forbidden. The credentials provided do not have sufficient authority for this request"}},"security":[{"Bearer":[]}]}},"/dispatch/{dispatch_id}":{"get":{"tags":["Get Dispatch by UUID"],"summary":"Get Dispatch by UUID","description":"Get Dispatch Platforms","parameters":[{"name":"dispatch_id","in":"path","description":"The Karhoo Dispatch Id (uuid)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dispatch"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized. Invalid credentials provided"},"403":{"description":"Forbidden. The credentials provided do not have sufficient authority for this request"}},"security":[{"Bearer":[]}]}},"/dispatch/{dispatch_id}/fare-component-mappings":{"put":{"tags":["Update Dispatch Fare Component Mappings"],"summary":"Update Dispatch Fare Component Mappings","description":"Updates Dispatch Fare Component Mappings","parameters":[{"name":"dispatch_id","in":"path","description":"The Karhoo Dispatch Id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateFareComponentMappingRequest"}}},"description":"request body","required":true},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MappedFareComponent"}}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized. Invalid credentials provided"},"403":{"description":"Forbidden. The credentials provided do not have sufficient authority for this request"}},"security":[{"Bearer":[]}]}},"/coverages":{"get":{"tags":["Get coverage areas"],"summary":"Get Coverage Areas","description":"Retrieve all coverage areas","parameters":[{"in":"query","name":"offset","description":"Pagination offset","required":false,"schema":{"type":"string"}},{"in":"query","name":"limit","description":"Pagination limit","required":false,"schema":{"type":"string"}},{"in":"query","name":"search_term","description":"free form search parameter for filtering an organisations users","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GeometryCollection"}}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized. Invalid credentials provided"},"403":{"description":"Forbidden. The credentials provided do not have sufficient authority for this request"}},"security":[{"Bearer":[]}]},"post":{"tags":["Create Coverage Areas"],"summary":"Create new Coverage Area","description":"New Coverage Area","requestBody":{"$ref":"#/components/requestBodies/Geometry"},"responses":{"201":{"description":"new geometry created"},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized. Invalid credentials provided"},"403":{"description":"Forbidden. The credentials provided do not have sufficient authority for this request"}},"security":[{"Bearer":[]}]},"put":{"tags":["Update Coverage Area"],"summary":"Update Coverage Area","description":"Update Coverage Are","requestBody":{"$ref":"#/components/requestBodies/Geometry"},"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Geometry"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized. Invalid credentials provided"},"403":{"description":"Forbidden. The credentials provided do not have sufficient authority for this request"}},"security":[{"Bearer":[]}]}},"/public-coverages":{"get":{"tags":["Get public coverage areas"],"summary":"Get public Coverage Areas","description":"Retrieve public coverage areas","parameters":[{"in":"query","name":"offset","description":"Pagination offset","required":false,"schema":{"type":"string"}},{"in":"query","name":"limit","description":"Pagination limit","required":false,"schema":{"type":"string"}},{"in":"query","name":"search_term","description":"free form search parameter for filtering an organisations users","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GeometryCollection"}}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/fleet-coverages":{"get":{"tags":["Get coverage areas"],"summary":"Get Coverage Areas","description":"Retrieve all coverage areas linked to a fleet","responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GeometryCollection"}}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized. Invalid credentials provided"},"403":{"description":"Forbidden. The credentials provided do not have sufficient authority for this request"}},"security":[{"Bearer":[]}]}},"/fare-components":{"get":{"tags":["Get fare components"],"summary":"Get all available available fare components","description":"The list of all available Karhoo fare components","responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FareComponent"}}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized. Invalid credentials provided"},"403":{"description":"Forbidden. The credentials provided do not have sufficient authority for this request"}},"security":[{"Bearer":[]}]}},"/fleet/filters":{"get":{"tags":["Get fleet filters"],"summary":"Get all available filters","description":"The list of all available fleet filters","responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FleetFilterArray"}}}}}},"security":[{"Bearer":[]}]}},"/vehicle-types":{"get":{"tags":["Vehicle classification"],"summary":"Get available vehicle types","description":"Vehicle type is an alias communicating the physical presence of a vehicle which is common across all auto manufactures (Moto, Standard, MPV, Commercial).","responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VehicleTypeCollection"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized. Invalid credentials provided"},"403":{"description":"Forbidden. The credentials provided do not have sufficient authority for this request"}},"security":[{"Bearer":[]}]}},"/vehicle-tags":{"get":{"tags":["Vehicle classification"],"summary":"Get available vehicle tags","description":"Vehicle tags describe special permutations of vehicles (Electric, Child Seat, Wheelchair).","responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VehicleTagCollection"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized. Invalid credentials provided"},"403":{"description":"Forbidden. The credentials provided do not have sufficient authority for this request"}},"security":[{"Bearer":[]}]}},"/supply/form-submit":{"post":{"tags":["Post onboarding form"],"summary":"Record submission of a fleet onboarding form","description":"Add an event to the platform for a form submisison on a 3rd party application.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Form"}}},"description":"request body","required":true},"responses":{"204":{"description":"post ok"},"400":{"description":"Invalid input","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized. Invalid credentials provided"}}}},"/supply-partners/{partner_id}":{"get":{"tags":["Supply partner"],"summary":"Get supply partner by ID","operationId":"getSupplyPartner","parameters":[{"name":"partner_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Supply partner returned","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupplyPartner"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized. Invalid credentials provided"},"403":{"description":"Forbidden"}},"security":[{"Bearer":[]}]},"put":{"tags":["Supply partner"],"summary":"Update supply partner","operationId":"updateSupplyPartner","parameters":[{"name":"partner_id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupplyPartnerSpec"}}}},"responses":{"200":{"description":"Partner has been updated"},"400":{"description":"Invalid input","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized. Invalid credentials provided"},"403":{"description":"Forbidden"}},"security":[{"Bearer":[]}]}},"/supply-partners/{partner_id}/logo-upload":{"put":{"tags":["Supply partner"],"summary":"Update supply partner logo","operationId":"updateSupplyPartnerLogo","parameters":[{"name":"partner_id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"description":"The file to upload.","type":"string","format":"binary"}}}}}},"responses":{"200":{"description":"Partner logo has been updated","content":{"*/*":{"schema":{"$ref":"#/components/schemas/LogoUploadedResponse"}}}},"400":{"description":"Invalid input","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized. Invalid credentials provided"},"403":{"description":"Forbidden"}},"security":[{"Bearer":[]}]}},"/supply-partners/{partner_id}/supply-products":{"get":{"tags":["Supply partner"],"summary":"Get supply products by partner ID","operationId":"getSupplyProducts","parameters":[{"name":"partner_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FleetArray"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized. Invalid credentials provided"},"403":{"description":"Forbidden. The credentials provided do not have sufficient authority for this request"}},"security":[{"Bearer":[]}]}}},"servers":[{"url":"https://rest.sandbox.karhoo.com/v1/onboarding"}],"components":{"requestBodies":{"Fleet":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Fleet"}}},"description":"request body","required":true},"Geometry":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Geometry"}}},"description":"request body","required":true}},"securitySchemes":{"Bearer":{"description":"For accessing the API a valid JWT token must be passed in all the queries\nin the 'Authorization' header.\n\nA valid JWT token is generated by the v1/auth API here: https://docs.karhoo.com/v1/auth/\n\nThe following syntax must be used in the 'Authorization' header :\n\n`Bearer: xxxxxx.yyyyyyy.zzzzzz`","type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"ErrorResponse":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/Response"},"code":{"type":"string","description":"error code"},"message":{"type":"string","description":"description of the error"}}},"Response":{"type":"object","properties":{"details":{"type":"array","items":{"$ref":"#/components/schemas/Info"}},"code":{"type":"string","description":"Karhoo error code"},"message":{"type":"string","description":"description of the error"}}},"Info":{"type":"object","properties":{"message":{"type":"string"},"detail":{"type":"string"}}},"State":{"type":"string","description":"The state of the fleet:\n\n- NEW:\n    Fleet is setup with basic information, technical integration not started.\n    Fleet can’t be booked in this state.\n\n- LIVE:\n    Fleets in this state can be booked by all Demand Partners.\n\n- DISABLED:\n    Fleets are temporarily removed from booking due to technical or operational issues (e.g. strikes).\n    Only Users with role \"Internal_Tester\" can book Fleets in this state.\n\n- INFO_ONLY:\n    Only QTA and Quotes are enabled, no booking\n\n- DEMO:\n    Fleet state for Karhoo smoke tests.\n    Only Users with role \"Bot\" can book Fleets in this state.\n\n- TESTING:\n    The Fleet is in the process of being configured and thoroughly tested.\n    Only Users with role \"Internal_tester\" can book Fleets in this state.\n\n- BETA:\n    Fleets in this state have completed technical, operational and financial configuration.\n    They can be booked for ghost trips by Karhoo employees or external parties.\n    Only Users with role \"Beta\" can book Fleets in this state.\n\n- ONBOARDING:\n    Fleet is in the process to be onboarded from a technical perspective.\n    Only Users with role \"Onboarding\" can book Fleets in this state\n\n- EXCHANGE_READY:\n    The technical integration with the Fleet (API keys and custom settings) is completed.\n    Basic configuration available for further integration test bookings.\n    Only Users with role \"Onboarding\" and \"Internal_tester\" can book Fleets in this state.\n\n- DISCONTINUED:\n    Fleets are not expected to be ever booked again within the Karhoo platform, a ‘soft delete’.\n","enum":["NEW","LIVE","DISABLED","INFO_ONLY","DEMO","TESTING","BETA","ONBOARDING","EXCHANGE_READY","DISCONTINUED"]},"QTAType":{"type":"string","description":"- NO_QTA: QTA not supported\n- DMS: DMS provides QTA\n- KARHOO: Karhoo Calculates QTA from nearby cars\n- DMS_AND_KARHOO: Karhoo asks for both QTA and nearby cars\n- CACHED: Calculate QTA from Cached Vehicle Positions\n- CACHED_AND_DMS: Calculate QTA from Cached Vehicle Positions AND ask for QTA\n","enum":["NO_QTA","DMS","KARHOO","DMS_AND_KARHOO","CACHED","CACHED_AND_DMS"]},"FareType":{"type":"string","description":"- FARE_TYPE_NOT_SET: Not configured\n- FIXED: Fixed price\n- METERED: Taxi meter\n- ESTIMATED: Price is given in a range estimated from price history\n","enum":["FARE_TYPE_NOT_SET","FIXED","METERED","ESTIMATED"]},"BookingRestriction":{"type":"string","description":"Restrict fleet to accepting ASAP or Pre-book only:\n- NO_RESTRICTION: Both ASAP and Pre-book possible\n- ASAP_ONLY: ASAP booking only\n- PREBOOK_ONLY: Prebooking only\n","enum":["NO_RESTRICTION","ASAP_ONLY","PREBOOK_ONLY"]},"BatchType":{"type":"string","description":"If being picked up at an Airport, the pickup type:\n- BATCH_TYPE_NOT_SET: Not configured\n- PER_FLEET_PER_VEHICLE_TYPE: Make an API call for every vehicle type for every fleet\n- PER_FLEET: Make a single API call for every fleet\n- PER_DMS_PER_VEHICLE_TYPE:  Make an API call for every vehicle type for every DMS\n- PER_DMS: Make a single API call for every DMS","enum":["BATCH_TYPE_NOT_SET","PER_FLEET_PER_VEHICLE_TYPE","PER_FLEET","PER_DMS_PER_VEHICLE_TYPE","PER_DMS"]},"VehicleAttributes":{"type":"object","description":"A list of attributes a vehicle can have","properties":{"passenger_capacity":{"type":"number","format":"uint32","example":3},"luggage_capacity":{"type":"number","format":"uint32","example":2},"hybrid":{"type":"boolean","example":false},"electric":{"type":"boolean","example":true},"child_seat":{"type":"boolean"},"tags":{"type":"array","example":["electric","child-seat"],"items":{"type":"string"}}}},"MappedVehicle":{"type":"object","properties":{"external_vehicle_type":{"type":"string","description":"DMS Vehicle Type Id"},"vehicle_class":{"type":"string","description":"The Karhoo Global Vehicle Class"},"vehicle_type":{"type":"string","example":"mpv","description":"The Karhoo Global Vehicle Type"},"label":{"type":"string","description":"The human readable label for the Supplier's Vehicle"},"class_id":{"type":"string","description":"The Karhoo Vehicle Class Id"},"external_vehicle_name":{"type":"string","description":"The human readable name for DMS vehicle type"},"is_active":{"type":"boolean"},"attributes":{"$ref":"#/components/schemas/VehicleAttributes"}}},"VehicleClass":{"type":"object","properties":{"id":{"type":"string","description":"The Karhoo Vehicle Class Id"},"name":{"type":"string","description":"Name of Karhoo Global Vehicle Class"},"description":{"type":"string"}}},"VehicleType":{"type":"object","properties":{"id":{"type":"string","description":"The Karhoo Vehicle Type ID","example":"mpv"},"name":{"type":"string","description":"Name of Karhoo Global Vehicle Type","example":"MPV"},"description":{"type":"string"}}},"VehicleTag":{"type":"object","properties":{"id":{"type":"string","description":"The Karhoo Vehicle Tag ID","example":"child-seat"},"name":{"type":"string","description":"Name of Karhoo Vehicle Tag","example":"Child seat"},"description":{"type":"string"}}},"VehicleTypeCollection":{"type":"object","description":"A collection of vehicle types","required":["vehicle_types"],"properties":{"vehicle_types":{"type":"array","items":{"$ref":"#/components/schemas/VehicleType"}}}},"VehicleTagCollection":{"type":"object","description":"A collection of vehicle tags","required":["vehicle_tags"],"properties":{"vehicle_tags":{"type":"array","items":{"$ref":"#/components/schemas/VehicleTag"}}}},"DurationConfiguration":{"type":"object","properties":{"duration":{"type":"string","description":"The time difference between updates and now","example":"1h"},"interval":{"type":"string","description":"The time between polling attempts","example":"30s"}}},"TripSchedulerConfiguration":{"type":"object","properties":{"before_pickup":{"type":"array","description":"The Interval is chosen with the closest duration greater than time delta from pickup time","items":{"$ref":"#/components/schemas/DurationConfiguration"}},"after_pickup":{"type":"array","description":"The Interval is chosen with the closest duration less than the time since last update for a In Progress Trip","items":{"$ref":"#/components/schemas/DurationConfiguration"}},"after_completed":{"type":"array","description":"The Interval is chosen with the closest duration less than the time since last update for a Completed Trip","items":{"$ref":"#/components/schemas/DurationConfiguration"}},"completed_with_fare":{"type":"array","description":"The Interval is chosen with the closest duration less than the time since last update for a Completed Trip with Fare","items":{"$ref":"#/components/schemas/DurationConfiguration"}},"polling_limit":{"type":"string","description":"The maximum amount of time since last change that we will allow polling","example":"96h"}}},"FareComponent":{"type":"object","properties":{"id":{"type":"string","description":"Karhoo Id"},"name":{"type":"string","description":"Human readable name"},"is_commissionable":{"type":"boolean","description":"Is it commissionable"}}},"MappedFareComponent":{"type":"object","properties":{"external_component_id":{"type":"string","description":"DMS Id for Fare Breakdown Component"},"name":{"type":"string","description":"Karhoo Name for Fare Breakdown Component"}}},"RegulationType":{"type":"string","description":"Indicates how the fleet is regulated:\n- NO_REGULATION_TYPE: The regulation type is not yet known for the fleet\n- PRIVATE_HIRE_VEHICLE: The fleet is under PHV regulations\n- REGULATED_TAXI: Regulated Taxi\n- CUSTOM_COUNTRY_CONFIG: Custom country config\n- NETWORK_CONFIG: Network fleet has special requirements on how taxes apply to the 'marketplace fee' config\n","enum":["NO_REGULATION_TYPE","PRIVATE_HIRE_VEHICLE","REGULATED_TAXI","CUSTOM_COUNTRY_CONFIG","NETWORK_CONFIG"]},"FeeUpliftMethodType":{"type":"string","description":"Determines whether fee uplift is included in the fleet fee:\n- NO_FEE_UPLIFT_METHOD_TYPE: The fee uplift computation method is not yet set\n- EMBEDDED_TO_BASE_FARE: The fee uplift is embedded in the fee\n- SEPARATE_COMPONENT: The fee uplift is provided as a separate component\n","enum":["NO_FEE_UPLIFT_METHOD_TYPE","EMBEDDED_TO_BASE_FARE","SEPARATE_COMPONENT"]},"FeeUpliftComputation":{"type":"object","required":["methods"],"properties":{"methods":{"type":"array","items":{"$ref":"#/components/schemas/FeeUpliftMethodType"}}}},"Fleet":{"type":"object","properties":{"configuration":{"type":"string","description":"Custom Configuration as a JSON String","example":""},"name":{"type":"string","description":"Name of Fleet.","example":"Zebrea"},"phone_number":{"type":"string","description":"E.164 formatted phone number of the driver https://en.wikipedia.org/wiki/E.164","example":"+12121231234"},"image_url":{"type":"string","description":"Logo URL of the fleet. The image should have a 1:1 aspect ratio and can be a gif, jpg or png.","example":"https://raw.githubusercontent.com/encharm/Font-Awesome-SVG-PNG/master/black/png/22/user.png"},"fleet_id":{"type":"string","description":"Karhoo UUID of fleet","example":"98de3daa-5c20-11e7-ba38-42010a84014b"},"dispatch_id":{"type":"string","description":"Karhoo UUID of DMS","example":"cc775eda-950d-4a77-aa83-172d487a4cbf"},"supplier_id":{"type":"string","description":"Karhoo UUID of Supplier","example":"98de3daa-5c20-11e7-ba38-42010a84014"},"state":{"$ref":"#/components/schemas/State"},"currency":{"type":"string","description":"Default currency for fleet, 3-letter currency code defined in ISO 4217.","example":"GBP"},"country_code":{"type":"string","description":"CLDR region code of the country","example":"UK"},"supply_partner_id":{"type":"string","description":"Supply partner UUID","example":"1d9fb82e-3355-4763-96a6-a1cbcb75acb9"},"fleet_account":{"type":"string","description":"Fleet account","example":"karhoo_api"},"commercial_models":{"type":"array","description":"Fleet commercial model, one of:\n  - \"B2B\"\n  - \"B2B2C\"\n  - \"B2C\"\n","items":{"type":"string"}},"terms_conditions_url":{"type":"string","description":"URL of Fleet T&C's"},"email":{"type":"string","description":"Email of Fleet"},"description":{"type":"string","description":"Fleet tag line"},"salesforce_id":{"type":"string","minLength":1},"default_fare_type":{"$ref":"#/components/schemas/FareType"},"vehicle_map":{"type":"array","description":"Vehicle Mapping for Fleet","items":{"$ref":"#/components/schemas/MappedVehicle"}},"fare_component_map":{"type":"array","description":"Vehicle Mapping for Fleet","items":{"$ref":"#/components/schemas/MappedFareComponent"}},"server_address":{"type":"string","description":"Request URL of server"},"external_fleet_id":{"type":"string","description":"DMS Id of the Fleet"},"qta_type":{"$ref":"#/components/schemas/QTAType"},"quote_batch_type":{"$ref":"#/components/schemas/BatchType"},"qta_batch_type":{"$ref":"#/components/schemas/BatchType"},"availability_batch_type":{"$ref":"#/components/schemas/BatchType"},"vehicle_position_polling":{"type":"boolean","description":"Poll for fleet wide availability"},"qta_threshold":{"type":"integer","format":"int32","description":"set the threshold for valid QTAs"},"disabled_notifications":{"type":"array","description":"Disabled notifications","items":{"$ref":"#/components/schemas/NotificationType"}},"min_prebook_leadtime":{"type":"integer","format":"int32","description":"Minimum prebook leadtime in minutes"},"max_prebook_leadtime":{"type":"string","description":"Maximum prebook leadtime as a duration in hours expressed in seconds","example":"7200s"},"booking_restriction":{"$ref":"#/components/schemas/BookingRestriction"},"commission":{"type":"string","description":"Deprecated - has no effect"},"trip_scheduler_configuration":{"$ref":"#/components/schemas/TripSchedulerConfiguration"},"shared_secret":{"type":"string","description":"Used to sign outgoing supply-api requests"},"prebook_lead_time_enabled":{"type":"boolean","description":"enable filtering based on prebook lead times"},"main_base":{"$ref":"#/components/schemas/FleetBase"},"fare_is_pre_gross":{"type":"boolean","example":false},"fare_adjustment_period_minutes":{"type":"integer","format":"int32","description":"The duration in minutes the fleet has to adjust the fare before it is marked automatically for invoicing"},"language_code":{"type":"string","description":"locale following IETF BCP 47","example":"en-GB or en"},"quote_predictions_disabled":{"type":"boolean","description":"switches off predictions for a given fleet"},"dms_requests_percentage_for_unreliable_predicted_quotes":{"type":"integer","format":"uint32","description":"probability of how likely system will call DMS to get a real quote if prediction was unrealiable","maximum":100,"minimum":0},"debug_enabled_until":{"type":"string","description":"enables detailed debugging for the fleet request & responses until the time specified as ISO 8601 Date Time string","example":"2019-08-08T14:04:55.319Z"},"regulation_type":{"$ref":"#/components/schemas/RegulationType"},"vat_excluded":{"type":"boolean"},"fully_trusted_model":{"type":"boolean"},"tax_rate_provided_by_dms":{"type":"boolean"},"fee_provided_by_dms":{"type":"boolean"},"external_invoice_source":{"type":"boolean"},"capabilities":{"type":"array","items":{"$ref":"#/components/schemas/FleetCapabilityInfo"}},"fee_uplift_computation_method":{"$ref":"#/components/schemas/FeeUpliftMethodType"},"fare_configuration":{"$ref":"#/components/schemas/FleetFareConfiguration"},"labels":{"type":"array","items":{"type":"string"}},"self_onboarded":{"type":"boolean"},"cancellation_fee_provided_by_dms":{"type":"boolean"},"internal_fleet_name":{"type":"string"}}},"FleetBase":{"type":"object","required":["name","latitude","longitude"],"properties":{"name":{"type":"string","description":"The name of the fleet base","example":"Harrods Road 27 - HQ"},"latitude":{"type":"number","format":"double","description":"The latitude in degrees. It must be in the range [-90.0, +90.0]","example":51.5086692},"longitude":{"type":"number","format":"double","description":"The longitude in degrees. It must be in the range [-180.0, +180.0]","example":-0.1375291}}},"Dispatch":{"type":"object","required":["name","salesforce_id"],"properties":{"configuration":{"type":"string","description":"Custom Configuration as a JSON String","example":""},"name":{"type":"string","description":"Name of Fleet.","example":"Zebrea"},"dispatch_id":{"type":"string","description":"Karhoo UUID of DMS","example":"cc775eda-950d-4a77-aa83-172d487a4cbf"},"qta_type":{"$ref":"#/components/schemas/QTAType"},"quote_batch_type":{"$ref":"#/components/schemas/BatchType"},"qta_batch_type":{"$ref":"#/components/schemas/BatchType"},"availability_batch_type":{"$ref":"#/components/schemas/BatchType"},"description":{"type":"string","description":"Fleet tag line"},"salesforce_id":{"type":"string","minLength":1},"vehicle_map":{"type":"array","description":"Vehicle Mapping for Fleet","items":{"$ref":"#/components/schemas/MappedVehicle"}},"fare_component_map":{"type":"array","description":"Vehicle Mapping for Fleet","items":{"$ref":"#/components/schemas/MappedFareComponent"}},"shared_secret":{"type":"string","description":"Used to sign outgoing supply-api requests"},"server_address":{"type":"string","description":"Request URL of server"},"dms_quote_required_for_booking":{"type":"boolean","description":"Whether DMS requires a real quote to be requested before booking"},"fleet_template":{"$ref":"#/components/schemas/Fleet"}}},"NotificationType":{"type":"string","description":"Notifications are sent upon a particular event:\n- NO_TYPE\n- TRIP_UPDATE\n- VEHICLE_REALLOCATION\n- RECEIPT\n","enum":["NO_TYPE","TRIP_UPDATE","VEHICLE_REALLOCATION","RECEIPT"]},"CoverageType":{"type":"string","description":"If being picked up at an Airport, the pickup type:\n- ASAP\n- PREBOOK\n- ASAP_AND_PREBOOK\n","enum":["COVERAGE_TYPE_NOT_SET","ASAP","PREBOOK","ASAP_AND_PREBOOK"]},"MappedCoverageArea":{"type":"object","properties":{"coverage_area_id":{"type":"string","description":"UUID for Coverage Area"},"description":{"type":"string","description":"Notes for mapping"},"coverage_area_type":{"$ref":"#/components/schemas/CoverageType"},"is_public":{"type":"boolean","description":"Determines if the coverage area is publicly retrievable"},"pickup_only":{"type":"boolean","description":"Limits the coverage area to only allow pickups from within"},"restricted":{"type":"boolean","description":"Marks the coverage area as restricted (exclusion zone)"}}},"Geometry":{"type":"object","description":"GeoJSON geometry","discriminator":{"propertyName":"type"},"required":["type"],"externalDocs":{"url":"http://geojson.org/geojson-spec.html#geometry-objects"},"properties":{"type":{"type":"string","enum":["Polygon","MultiPolygon"],"description":"the geometry type"}}},"Point2D":{"type":"array","description":"2d Point","items":{"type":"number"}},"CoordinateArray":{"type":"array","description":"Array of 2D Points","items":{"$ref":"#/components/schemas/Point2D"}},"Polygon":{"type":"object","description":"GeoJSON geometry","externalDocs":{"url":"http://geojson.org/geojson-spec.html#id4"},"allOf":[{"$ref":"#/components/schemas/Geometry"},{"properties":{"coordinates":{"type":"array","items":{"$ref":"#/components/schemas/CoordinateArray"}}}}]},"MultiPolygon":{"type":"object","description":"GeoJSON geometry","externalDocs":{"url":"http://geojson.org/geojson-spec.html#id6"},"allOf":[{"$ref":"#/components/schemas/Geometry"},{"properties":{"coordinates":{"type":"array","items":{"type":"array","items":{"$ref":"#/components/schemas/CoordinateArray"}}}}}]},"CoveragesList":{"type":"object","description":"paginated list of coverage areas","properties":{"count":{"type":"number","format":"int32","example":1},"areas":{"type":"array","items":{"$ref":"#/components/schemas/GeometryCollection"}}}},"GeometryCollection":{"type":"object","description":"GeoJSON geometry collection","required":["type","geometries"],"externalDocs":{"url":"http://geojson.org/geojson-spec.html#geometrycollection"},"properties":{"type":{"type":"string","enum":["GeometryCollection"],"description":"GeometryCollection"},"geometries":{"type":"array","items":{"$ref":"#/components/schemas/Geometry"}}}},"UpdateFareComponentMappingRequest":{"type":"object","properties":{"fare_components":{"type":"array","description":"List of Mapped Fare Component objects","items":{"$ref":"#/components/schemas/MappedFareComponent"}}}},"UpdateFleetCoverageMappingRequest":{"type":"object","properties":{"coverage_area_mappings":{"type":"array","description":"List of mapped coverage areas","items":{"$ref":"#/components/schemas/MappedCoverageArea"}}}},"UpdateFleetVehicleMappingRequest":{"type":"object","properties":{"vehicle_mappings":{"type":"array","description":"List of Mapped Vehicle objects","items":{"$ref":"#/components/schemas/MappedVehicle"}}}},"FleetArray":{"type":"object","properties":{"fleets":{"type":"array","items":{"$ref":"#/components/schemas/Fleet"}}}},"DispatchArray":{"type":"object","properties":{"dispatch_platforms":{"type":"array","items":{"$ref":"#/components/schemas/Dispatch"}}}},"FleetMinArray":{"type":"object","properties":{"count":{"type":"number","format":"int32","example":1},"fleets":{"type":"array","items":{"$ref":"#/components/schemas/FleetMin"}}}},"FleetMin":{"type":"object","properties":{"name":{"type":"string","description":"Name of Fleet.","example":"Antelope"},"fleet_id":{"type":"string","description":"Karhoo UUID of fleet","example":"98de3daa-5c20-11e7-ba38-42010a84014b"},"dispatch_id":{"type":"string","description":"Karhoo UUID of DMS","example":"cc775eda-950d-4a77-aa83-172d487a4cbf"},"dispatch_name":{"type":"string","description":"Name of DMS.","example":"Zoo"},"state":{"$ref":"#/components/schemas/State"},"description":{"type":"string","description":"Fleet tag line"},"salesforce_id":{"type":"string","minLength":1},"external_fleet_id":{"type":"string","description":"DMS Id of the Fleet"},"image_url":{"type":"string","description":"Logo URL of the fleet. The image should have a 1:1 aspect ratio and can be a gif, jpg or png.","example":"https://raw.githubusercontent.com/encharm/Font-Awesome-SVG-PNG/master/black/png/22/user.png"},"internal_fleet_name":{"type":"string"}}},"FleetFilterArray":{"type":"object","properties":{"filters":{"type":"array","items":{"$ref":"#/components/schemas/FleetFilter"}}}},"FleetFilterType":{"type":"string","description":"- string: str\n- map: map\n","enum":["string","map"]},"FleetFilter":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/FleetFilterField"},"description":{"type":"string"},"type":{"$ref":"#/components/schemas/FleetFilterType"},"values":{"type":"object","additionalProperties":{"type":"string"}}}},"FleetFilterRequest":{"type":"object","required":["queries"],"properties":{"queries":{"type":"array","description":"An array of conditions to perform the filtering on.\nEach condition might consist of multiple filters.\nThe conditions are joined by the AND query, hence\nall the specified conditions must evaluate to true\nfor the request to return the given fleet.\nie. The outer array can contain condition like\n* (STATUS = \"Live\" OR STATUS = \"Testing\") AND\n* (NAME like \"foo\")\nwhere each bullet item is one element in the\n\"queries\" array\n","items":{"$ref":"#/components/schemas/FleetFilterAndQuery"},"uniqueItems":true}}},"FleetFilterField":{"type":"string","enum":["NAME","STATUS","COUNTRY_CODE","DISPATCH_ID","DEFAULT_FARE_TYPE","BOOKING_RESTRICTION","SERVING_LOCATION","CAPABILITY","DEMAND_PARTNER","INTERNAL_FLEET_NAME","LABEL"]},"FleetFilterCondition":{"type":"object","description":"An array of properties to perform the filtering on. The filtering accepts multi-select conditions. Fields are joined by the OR query.","required":["field","value","operator"],"properties":{"field":{"$ref":"#/components/schemas/FleetFilterField"},"value":{"type":"string"},"operator":{"$ref":"#/components/schemas/FilterOperator"}}},"FleetFilterAndQuery":{"type":"object","required":["filters"],"properties":{"intersect":{"description":"Whether the filter should act according to the \"intersect\" operation By default the \"union\" operation will be used.","type":"boolean"},"filters":{"description":"An array of filtering conditions. Each condition is joined\nby the OR query i.e.\n(STATUS = \"Live\" OR STATUS = \"Testing\") can be expressed\n","type":"array","items":{"$ref":"#/components/schemas/FleetFilterCondition"},"uniqueItems":true}}},"FilterOperator":{"type":"string","enum":["EQUAL","FUZZY_SEARCH","CONTAINS_GEO_FEATURE"]},"FleetFareComponentSettings":{"type":"object","properties":{"local_tax_percentage":{"description":"Local tax percentage","type":"number","format":"double","minimum":0,"maximum":100},"is_commissionable":{"description":"Can commission be applied","type":"boolean"}}},"FeeBreakdown":{"type":"object","properties":{"karhoo_fee_percentage":{"type":"number","format":"double","minimum":0,"maximum":100},"bss_fee_percentage":{"type":"number","format":"double","minimum":0,"maximum":100},"partner_fee_percentage":{"type":"number","format":"double","minimum":0,"maximum":100}}},"FleetFareComponentBreakdown":{"type":"object","properties":{"fare_component_settings":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/FleetFareComponentSettings"}}}},"FleetFareConfiguration":{"type":"object","properties":{"fare_component_breakdown":{"$ref":"#/components/schemas/FleetFareComponentBreakdown"},"commission_tax_percentage":{"type":"number","format":"double","minimum":0,"maximum":100},"marketplace_fees_tax_percentage":{"type":"number","format":"double","minimum":0,"maximum":100},"fee_breakdown":{"$ref":"#/components/schemas/FeeBreakdown"}}},"FleetTypeFareConfiguration":{"type":"object","properties":{"regulation_type":{"$ref":"#/components/schemas/RegulationType"},"fare_configuration":{"$ref":"#/components/schemas/FleetFareConfiguration"}}},"FleetTypeFareConfigurations":{"type":"object","properties":{"fleet_types":{"type":"array","items":{"$ref":"#/components/schemas/FleetTypeFareConfiguration"}}}},"CountryFleetFareConfiguration":{"type":"object","description":"Country based Fleet Fare configuration","properties":{"country_codes":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/FleetTypeFareConfigurations"}}}},"FleetCapabilityInfo":{"type":"object","required":["name","available"],"properties":{"name":{"$ref":"#/components/schemas/FleetCapability"},"available":{"type":"boolean"}}},"FleetCapabilityList":{"type":"object","required":["capabilities"],"properties":{"capabilities":{"type":"array","items":{"$ref":"#/components/schemas/FleetCapability"}}}},"FleetCapability":{"type":"string","enum":["GPS_TRACKING","FLIGHT_TRACKING","TRAIN_TRACKING","DRIVER_DETAILS_AVAILABLE","VEHICLE_DETAILS_AVAILABLE"]},"Form":{"type":"object","required":["sf_id"],"properties":{"region":{"type":"string"},"name":{"type":"string"},"fleet_type":{"type":"string"},"sf_id":{"type":"string"}}},"SupplyPartnerSpec":{"type":"object","properties":{"name":{"type":"string","description":"The supply partner name"},"phone_number":{"type":"string","description":"The supply partner phone number"},"email":{"type":"string","description":"The supply partner email"},"supplier_type":{"type":"string","description":"The supply partner type"},"vehicles_number":{"type":"integer","description":"The supply partner vehicles number"},"preferred_language":{"type":"string","description":"The supply partner preffered language"},"fleet_capabilities":{"type":"array","items":{"$ref":"#/components/schemas/FleetCapabilityInfo"}},"dispatch_id":{"type":"string","description":"The supply partner dispatch ID"},"logo_url":{"type":"string","description":"The supply partner logo url"}}},"SupplyPartner":{"type":"object","properties":{"supply_partner_id":{"type":"string","description":"The supply partner ID"},"name":{"type":"string","description":"The supply partner name"},"phone_number":{"type":"string","description":"The supply partner phone number"},"email":{"type":"string","description":"The supply partner email"},"supplier_type":{"type":"string","description":"The supply partner type"},"vehicles_number":{"type":"integer","description":"The supply partner vehicles number"},"preferred_language":{"type":"string","description":"The supply partner preffered language"},"fleet_capabilities":{"type":"array","items":{"$ref":"#/components/schemas/FleetCapabilityInfo"}},"dispatch_id":{"type":"string","description":"The supply partner dispatch ID"},"logo_url":{"type":"string","description":"The supply partner logo url"}},"required":["supply_partner_id","name"]},"LogoUploadedResponse":{"type":"object","properties":{"stored":{"type":"boolean","description":"Flag indicating if file has been stored"},"destination_url":{"type":"string","description":"CDN path"}}},"FleetLabels":{"type":"object","properties":{"labels":{"type":"array","items":{"$ref":"#/components/schemas/FleetLabel"}}}},"FleetLabel":{"type":"object","properties":{"name":{"type":"string"}}},"FleetExternalAccountSpec":{"type":"object","properties":{"name":{"type":"string","example":"premium-airport"},"description":{"type":"string","example":"Premium airport transfers"}}},"FleetExternalAccountsResponse":{"type":"object","properties":{"accounts":{"type":"array","items":{"$ref":"#/components/schemas/FleetExternalAccount"}}}},"FleetExternalAccount":{"type":"object","properties":{"id":{"type":"string","example":"1256"},"name":{"type":"string","example":"premium-airport"},"description":{"type":"string","example":"Premium airport transfers"}}},"AddFleetLabelRequest":{"type":"object","properties":{"label":{"type":"string","description":"A label to be added to the fleet"}}}}},"x-readme":{"explorer-enabled":true,"proxy-enabled":true}}