{"openapi":"3.1.0","info":{"title":"VEZILINK External API","version":"1.0.0"},"paths":{"/external/v1/trips":{"post":{"summary":"External Create Trip","operationId":"external_create_trip_external_v1_trips_post","parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Idempotency-Key"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalTripCreate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"CompanyApiKey":[]}]},"get":{"summary":"External List Trips","operationId":"external_list_trips_external_v1_trips_get","parameters":[{"name":"client_ref","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Client Ref"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":50,"title":"Limit"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"CompanyApiKey":[]}]}},"/external/v1/trips/{tracking_code}":{"get":{"summary":"External Get Trip","operationId":"external_get_trip_external_v1_trips__tracking_code__get","parameters":[{"name":"tracking_code","in":"path","required":true,"schema":{"type":"string","title":"Tracking Code"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"CompanyApiKey":[]}]}},"/external/v1/trips/{tracking_code}/status":{"post":{"summary":"External Set Trip Status","operationId":"external_set_trip_status_external_v1_trips__tracking_code__status_post","parameters":[{"name":"tracking_code","in":"path","required":true,"schema":{"type":"string","title":"Tracking Code"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalTripStatusIn"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"CompanyApiKey":[]}]}},"/external/v1/locations":{"post":{"summary":"External Push Location","operationId":"external_push_location_external_v1_locations_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalLocationIn"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"CompanyApiKey":[]}]}},"/public/v1/track/{tracking_code}":{"get":{"summary":"Public Track","operationId":"public_track_public_v1_track__tracking_code__get","parameters":[{"name":"tracking_code","in":"path","required":true,"schema":{"type":"string","title":"Tracking Code"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[]}},"/device/v1/location":{"post":{"summary":"Device Push Location","operationId":"device_push_location_device_v1_location_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"x-device-token","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Device-Token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceLocationIn"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"DeviceToken":[]}]}},"/public/v1/shipments/{token}":{"get":{"summary":"Public Get Shipment","operationId":"public_get_shipment_public_v1_shipments__token__get","parameters":[{"name":"token","in":"path","required":true,"schema":{"type":"string","title":"Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[]}},"/public/v1/shipments/{token}/qr.svg":{"get":{"summary":"Public Shipment Qr","operationId":"public_shipment_qr_public_v1_shipments__token__qr_svg_get","parameters":[{"name":"token","in":"path","required":true,"schema":{"type":"string","title":"Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[]}},"/public/v1/shipments/{token}/receive":{"post":{"summary":"Public Receive Shipment","operationId":"public_receive_shipment_public_v1_shipments__token__receive_post","parameters":[{"name":"token","in":"path","required":true,"schema":{"type":"string","title":"Token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShipmentReceiptIn"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[]}},"/external/v1/trips/{tracking_code}/shipments":{"post":{"summary":"External Create Shipment","operationId":"external_create_shipment_external_v1_trips__tracking_code__shipments_post","parameters":[{"name":"tracking_code","in":"path","required":true,"schema":{"type":"string","title":"Tracking Code"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShipmentCreateIn"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"CompanyApiKey":[]}]},"get":{"summary":"External List Shipments","operationId":"external_list_shipments_external_v1_trips__tracking_code__shipments_get","parameters":[{"name":"tracking_code","in":"path","required":true,"schema":{"type":"string","title":"Tracking Code"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"CompanyApiKey":[]}]}},"/external/v1/shipments/{shipment_id}/rotate-access":{"post":{"summary":"External Rotate Shipment Access","operationId":"external_rotate_shipment_access_external_v1_shipments__shipment_id__rotate_access_post","parameters":[{"name":"shipment_id","in":"path","required":true,"schema":{"type":"integer","title":"Shipment Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"CompanyApiKey":[]}]}}},"components":{"schemas":{"DeviceLocationIn":{"properties":{"lat":{"type":"number","title":"Lat"},"lon":{"type":"number","title":"Lon"},"ts":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ts"},"driver_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Driver Number"},"source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source"}},"type":"object","required":["lat","lon"],"title":"DeviceLocationIn"},"ExternalLocationIn":{"properties":{"driver_number":{"type":"string","title":"Driver Number"},"lat":{"type":"number","title":"Lat"},"lon":{"type":"number","title":"Lon"},"ts":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ts"},"source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source"}},"type":"object","required":["driver_number","lat","lon"],"title":"ExternalLocationIn"},"ExternalTripCreate":{"properties":{"title":{"type":"string","title":"Title"},"client_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Client Name"},"client_ref":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Client Ref"},"planned_start":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Planned Start"},"planned_end":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Planned End"},"metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Metadata"},"stops":{"anyOf":[{"items":{"$ref":"#/components/schemas/ExternalTripStopIn"},"type":"array"},{"type":"null"}],"title":"Stops"}},"type":"object","required":["title"],"title":"ExternalTripCreate"},"ExternalTripStatusIn":{"properties":{"status":{"type":"string","title":"Status"}},"type":"object","required":["status"],"title":"ExternalTripStatusIn"},"ExternalTripStopIn":{"properties":{"name":{"type":"string","title":"Name"},"city_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"City Id"},"planned_arrival":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Planned Arrival"},"planned_departure":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Planned Departure"}},"type":"object","required":["name"],"title":"ExternalTripStopIn"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ReceiptItemIn":{"properties":{"item_id":{"type":"integer","title":"Item Id"},"received_quantity":{"anyOf":[{"type":"number","maximum":1000000000.0,"minimum":0.0},{"type":"null"}],"title":"Received Quantity"},"condition":{"type":"string","enum":["ok","partial","problem"],"title":"Condition","default":"ok"},"comment":{"anyOf":[{"type":"string","maxLength":500},{"type":"null"}],"title":"Comment"}},"type":"object","required":["item_id"],"title":"ReceiptItemIn"},"ShipmentCreateIn":{"properties":{"recipient_name":{"type":"string","maxLength":160,"minLength":1,"title":"Recipient Name"},"recipient_phone":{"anyOf":[{"type":"string","maxLength":40},{"type":"null"}],"title":"Recipient Phone"},"recipient_email":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Recipient Email"},"external_ref":{"anyOf":[{"type":"string","maxLength":160},{"type":"null"}],"title":"External Ref"},"note":{"anyOf":[{"type":"string","maxLength":2000},{"type":"null"}],"title":"Note"},"metadata":{"additionalProperties":true,"type":"object","title":"Metadata"},"items":{"items":{"$ref":"#/components/schemas/ShipmentItemIn"},"type":"array","maxItems":500,"minItems":1,"title":"Items"},"packages":{"items":{"$ref":"#/components/schemas/ShipmentPackageIn"},"type":"array","maxItems":500,"title":"Packages"}},"type":"object","required":["recipient_name","items"],"title":"ShipmentCreateIn"},"ShipmentItemIn":{"properties":{"category":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"title":"Category"},"name":{"type":"string","maxLength":200,"minLength":1,"title":"Name"},"sku":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"title":"Sku"},"quantity":{"anyOf":[{"type":"number","maximum":1000000000.0,"minimum":0.0},{"type":"null"}],"title":"Quantity"},"unit":{"anyOf":[{"type":"string","maxLength":40},{"type":"null"}],"title":"Unit"},"weight_kg":{"anyOf":[{"type":"number","maximum":100000000.0,"minimum":0.0},{"type":"null"}],"title":"Weight Kg"},"metadata":{"additionalProperties":true,"type":"object","title":"Metadata"}},"type":"object","required":["name"],"title":"ShipmentItemIn"},"ShipmentPackageIn":{"properties":{"label":{"type":"string","maxLength":160,"minLength":1,"title":"Label"},"package_type":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}],"title":"Package Type"},"item_indexes":{"items":{"type":"integer"},"type":"array","title":"Item Indexes"},"metadata":{"additionalProperties":true,"type":"object","title":"Metadata"}},"type":"object","required":["label"],"title":"ShipmentPackageIn"},"ShipmentReceiptIn":{"properties":{"pin":{"type":"string","maxLength":12,"minLength":4,"title":"Pin"},"recipient_name":{"type":"string","maxLength":160,"minLength":1,"title":"Recipient Name"},"comment":{"anyOf":[{"type":"string","maxLength":2000},{"type":"null"}],"title":"Comment"},"items":{"items":{"$ref":"#/components/schemas/ReceiptItemIn"},"type":"array","maxItems":500,"title":"Items"}},"type":"object","required":["pin","recipient_name"],"title":"ShipmentReceiptIn"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}},"securitySchemes":{"CompanyApiKey":{"type":"http","scheme":"bearer","description":"API-ключ компании vl_live_*"},"DeviceToken":{"type":"http","scheme":"bearer","description":"Токен устройства vl_dev_*"}}},"servers":[{"url":"/","description":"Текущий сервер"}]}