openapi: 3.0.3
info:
title: 'Tez-Taxi API Documentation'
description: ''
version: 1.0.0
servers:
-
url: 'https://tez-taxi.uz'
tags:
-
name: Endpoints
description: ''
paths:
/api/v1/devices/register:
post:
summary: ''
operationId: postApiV1DevicesRegister
description: ''
parameters: []
responses: { }
tags:
- Endpoints
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
partner_id:
type: integer
description: 'The id
of an existing record in the partners table.'
example: 17
nullable: false
branch_id:
type: integer
description: 'The id
of an existing record in the branches table.'
example: 17
nullable: false
device_type:
type: string
description: ''
example: kiosk
nullable: true
enum:
- device
- tablet
- kiosk
- mobile
device_name:
type: string
description: 'Must not be greater than 255 characters.'
example: mqeopfuudtdsufvyvddqa
nullable: true
required:
- partner_id
- branch_id
security: []
'/api/v1/orders/{id}/cancel':
post:
summary: "Cancel an order\nPOST /api/v1/orders/{id}/cancel"
operationId: cancelAnOrderPOSTapiv1ordersidcancel
description: ''
parameters: []
responses: { }
tags:
- Endpoints
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
reason:
type: string
description: 'Must not be greater than 500 characters.'
example: vmqeopfuudtdsufvyvddq
nullable: true
security: []
parameters:
-
in: path
name: id
description: 'The ID of the order.'
example: consequatur
required: true
schema:
type: string
'/api/v1/orders/{id}/complete':
post:
summary: "Complete an order\nPOST /api/v1/orders/{id}/complete"
operationId: completeAnOrderPOSTapiv1ordersidcomplete
description: ''
parameters: []
responses: { }
tags:
- Endpoints
security: []
parameters:
-
in: path
name: id
description: 'The ID of the order.'
example: consequatur
required: true
schema:
type: string
'/api/v1/orders/{id}':
get:
summary: "Display the specified order\nGET /api/v1/orders/{id}"
operationId: displayTheSpecifiedOrderGETapiv1ordersid
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
error: Unauthenticated
timestamp: '2025-06-24T12:45:59.118308Z'
properties:
error:
type: string
example: Unauthenticated
timestamp:
type: string
example: '2025-06-24T12:45:59.118308Z'
tags:
- Endpoints
security: []
parameters:
-
in: path
name: id
description: 'The ID of the order.'
example: consequatur
required: true
schema:
type: string
/api/v1/orders:
post:
summary: "Store a newly created order\nPOST /api/v1/orders"
operationId: storeANewlyCreatedOrderPOSTapiv1orders
description: ''
parameters: []
responses: { }
tags:
- Endpoints
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
pickup_latitude:
type: number
description: 'Must be between -90 and 90.'
example: -89
nullable: false
pickup_longitude:
type: number
description: 'Must be between -180 and 180.'
example: -180
nullable: false
dropoff_latitude:
type: number
description: 'Must be between -90 and 90.'
example: -89
nullable: true
dropoff_longitude:
type: number
description: 'Must be between -180 and 180.'
example: -180
nullable: true
note:
type: string
description: 'Must not be greater than 500 characters.'
example: opfuudtdsufvyvddqamni
nullable: true
partner_order_id:
type: string
description: 'Must not be greater than 255 characters.'
example: ihfqcoynlazghdtqtqxba
nullable: false
required:
- pickup_latitude
- pickup_longitude
- partner_order_id
security: []
/api/v1/partner:
get:
summary: ''
operationId: getApiV1Partner
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
error: 'API key is required'
message: 'Please provide an API key in the X-API-Key header or api_key query parameter'
properties:
error:
type: string
example: 'API key is required'
message:
type: string
example: 'Please provide an API key in the X-API-Key header or api_key query parameter'
tags:
- Endpoints
security: []
/api/v1/auth/login:
post:
summary: 'Authenticate user and return token.'
operationId: authenticateUserAndReturnToken
description: ''
parameters: []
responses: { }
tags:
- Endpoints
security: []
/api/v1/user:
get:
summary: 'Get the authenticated User.'
operationId: getTheAuthenticatedUser
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
error: Unauthenticated
timestamp: '2025-06-24T12:45:59.177425Z'
properties:
error:
type: string
example: Unauthenticated
timestamp:
type: string
example: '2025-06-24T12:45:59.177425Z'
tags:
- Endpoints
security: []
/api/v1/auth/logout:
post:
summary: 'Log the user out (Invalidate the token).'
operationId: logTheUserOutInvalidateTheToken
description: ''
parameters: []
responses: { }
tags:
- Endpoints
security: []