Swagger TEST
Swagger DEV
Sotrans Main Service 0.1
Sotrans Main Service swagger
Endpoints
GET /updates
Get Events
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
api_key |
query | None | No | ||
status_1c |
query | None | No |
Response 200 OK
[
{
"collection": "string",
"mongo_id": "string",
"status": "pending",
"code": null,
"payload": {}
}
]
Schema of the response body
{
"type": "array",
"items": {
"$ref": "#/components/schemas/Update1CModel"
},
"title": "Response Get Events Updates Get"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
PATCH /updates
Updates Statuses
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
api_key |
query | None | No |
Request body
[
{
"id": "string",
"status": "pending",
"code": null
}
]
Schema of the request body
{
"type": "array",
"items": {
"$ref": "#/components/schemas/Processing1CResult"
},
"title": "Updated"
}
Response 200 OK
Schema of the response body
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
PUT /{collection}/{object_id}/verification
Verify
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
collection |
path | string | No | ||
object_id |
path | string | No |
Request body
{
"status": "accepted",
"issuer_type": "director",
"object_id": null,
"collection": null
}
Schema of the request body
{
"properties": {
"status": {
"$ref": "#/components/schemas/VerificationStatus"
},
"issuer_type": {
"$ref": "#/components/schemas/VerificationIssuerType"
},
"object_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Object Id"
},
"collection": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Collection"
}
},
"type": "object",
"required": [
"status",
"issuer_type"
],
"title": "VerificationCreateModel"
}
Response 201 Created
{
"id": "string",
"status": null,
"issuer_type": null,
"object_id": "string",
"collection": "string",
"owner_id": null
}
Schema of the response body
{
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/VerificationStatus"
},
{
"type": "null"
}
]
},
"issuer_type": {
"anyOf": [
{
"$ref": "#/components/schemas/VerificationIssuerType"
},
{
"type": "null"
}
]
},
"object_id": {
"type": "string",
"title": "Object Id"
},
"collection": {
"type": "string",
"title": "Collection"
},
"owner_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Owner Id"
}
},
"type": "object",
"required": [
"object_id",
"collection"
],
"title": "VerificationDBModel"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 400 Bad Request
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 404 Not Found
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
DELETE /cleanup
Mongo Cleanup
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
days |
query | integer | No |
Response 204 No Content
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
POST /api-keys
Create Key
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No |
Request body
{
"name": "string"
}
Schema of the request body
{
"properties": {
"name": {
"type": "string",
"title": "Name"
}
},
"type": "object",
"required": [
"name"
],
"title": "Body_create_key_api_keys_post"
}
Response 200 OK
{
"name": null,
"created_at": null,
"owner": null,
"api_key": null,
"id": "string"
}
Schema of the response body
{
"properties": {
"name": {
"anyOf": [
{
"type": "string",
"maxLength": 80
},
{
"type": "null"
}
],
"title": "Name"
},
"created_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At"
},
"owner": {
"anyOf": [
{
"$ref": "#/components/schemas/SotransUserDBModel"
},
{
"type": "null"
}
]
},
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Api Key"
},
"id": {
"type": "string",
"title": "Id"
}
},
"type": "object",
"title": "APIKeyDBModel"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /api-keys
Get All Keys
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
assignment |
query | string | No | ||
limit |
query | integer | 200 | No | |
projection |
query | string | No | ||
search |
query | string | No | ||
skip |
query | integer | 0 | No | |
sort |
query | string | No | ||
where |
query | string | No |
Response 200 OK
{
"items": [
{
"name": null,
"created_at": null,
"owner": null,
"api_key": null,
"id": "string"
}
],
"total": 0
}
Schema of the response body
{
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/APIKeyDBModel"
},
"type": "array",
"title": "Items"
},
"total": {
"type": "integer",
"title": "Total"
}
},
"type": "object",
"required": [
"items",
"total"
],
"title": "GenericGetListResponse[APIKeyDBModel]"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
DELETE /api-keys/{name}
Remove Key By Name
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
name |
path | string | No |
Response 204 No Content
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /settings
Get Settings
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No |
Response 200 OK
{
"etag": null,
"reservation_interval_minutes": 0,
"confirmation_interval_minutes": 0
}
Schema of the response body
{
"properties": {
"etag": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Etag"
},
"reservation_interval_minutes": {
"type": "integer",
"maximum": 100000.0,
"minimum": 5.0,
"title": "Reservation Interval Minutes",
"default": 15
},
"confirmation_interval_minutes": {
"type": "integer",
"maximum": 150000.0,
"minimum": 5.0,
"title": "Confirmation Interval Minutes",
"default": 60
}
},
"type": "object",
"title": "AdminSettings"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
PATCH /settings
Put Settings
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No |
Request body
{
"etag": null,
"reservation_interval_minutes": 0,
"confirmation_interval_minutes": 0
}
Schema of the request body
{
"properties": {
"etag": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Etag"
},
"reservation_interval_minutes": {
"type": "integer",
"maximum": 100000.0,
"minimum": 5.0,
"title": "Reservation Interval Minutes",
"default": 15
},
"confirmation_interval_minutes": {
"type": "integer",
"maximum": 150000.0,
"minimum": 5.0,
"title": "Confirmation Interval Minutes",
"default": 60
}
},
"type": "object",
"title": "AdminSettings"
}
Response 200 OK
{
"etag": null,
"reservation_interval_minutes": 0,
"confirmation_interval_minutes": 0
}
Schema of the response body
{
"properties": {
"etag": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Etag"
},
"reservation_interval_minutes": {
"type": "integer",
"maximum": 100000.0,
"minimum": 5.0,
"title": "Reservation Interval Minutes",
"default": 15
},
"confirmation_interval_minutes": {
"type": "integer",
"maximum": 150000.0,
"minimum": 5.0,
"title": "Confirmation Interval Minutes",
"default": 60
}
},
"type": "object",
"title": "AdminSettings"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
PUT /scheduled/auction-finish
Auc Finish Scheduled Webhook
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No |
Request body
{
"orders_taken": [
{
"id": "string",
"auction_end_time": null,
"stops": null,
"peculiarities": null,
"cargo_type": null,
"truck_body": null,
"client_price": null,
"start_price": null,
"end_price": null,
"currency": null,
"currency_caption": null,
"vat_type": null,
"rate_step": null,
"status": null,
"note": null,
"external": null,
"client": null,
"assigned": null,
"carrier": null,
"driver": null,
"truck": null,
"trailer": null,
"documents": null,
"cancel_reason": null,
"etag": null,
"completed_stages": null,
"created_at": null,
"your_bid": null,
"best_bid": null,
"confirmation_end_time": null,
"reservation_end_time": null,
"short_id": null,
"deleted_at": null,
"current_stage": null,
"document_draft": null,
"start_price_km": null,
"end_price_km": null,
"route_km": null,
"text_search": null,
"updated": null
}
],
"orders_dropped": null
}
Schema of the request body
{
"properties": {
"orders_taken": {
"items": {
"$ref": "#/components/schemas/OrderDBModel"
},
"type": "array",
"title": "Orders Taken"
},
"orders_dropped": {
"items": {
"$ref": "#/components/schemas/OrderDBModel"
},
"type": "array",
"title": "Orders Dropped"
}
},
"type": "object",
"required": [
"orders_taken",
"orders_dropped"
],
"title": "AuctionEndNotificationsData"
}
Response 200 OK
Schema of the response body
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
PUT /scheduled/auction-finishes-soon
Auc Soon
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No |
Response 200 OK
Schema of the response body
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
POST /scheduled/confirmation-expired
Notify On Expired
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No |
Request body
[
{
"id": "string",
"auction_end_time": null,
"stops": null,
"peculiarities": null,
"cargo_type": null,
"truck_body": null,
"client_price": null,
"start_price": null,
"end_price": null,
"currency": null,
"currency_caption": null,
"vat_type": null,
"rate_step": null,
"status": null,
"note": null,
"external": null,
"client": null,
"assigned": null,
"carrier": null,
"driver": null,
"truck": null,
"trailer": null,
"documents": null,
"cancel_reason": null,
"etag": null,
"completed_stages": null,
"created_at": null,
"your_bid": null,
"best_bid": null,
"confirmation_end_time": null,
"reservation_end_time": null,
"short_id": null,
"deleted_at": null,
"current_stage": null,
"document_draft": null,
"start_price_km": null,
"end_price_km": null,
"route_km": null,
"text_search": null,
"updated": null
}
]
Schema of the request body
{
"items": {
"$ref": "#/components/schemas/OrderDBModel"
},
"type": "array",
"title": "Orders"
}
Response 200 OK
Schema of the response body
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /scheduled/confirmation_tick
Confirmed Timeout Warning
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No |
Response 200 OK
Schema of the response body
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
GET /scheduled/recommendations
Recommendations Reminder
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No |
Response 200 OK
Schema of the response body
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
POST /reports
Save Report Submission
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No |
Request body
{
"file_links": null,
"submitter": null,
"description": null
}
Schema of the request body
{
"properties": {
"file_links": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "File Links"
},
"submitter": {
"anyOf": [
{
"$ref": "#/components/schemas/SotransUserDBModel"
},
{
"type": "null"
}
]
},
"description": {
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "null"
}
],
"title": "Description"
}
},
"type": "object",
"title": "ReportCreateModel"
}
Response 200 OK
Schema of the response body
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /utils/users-sync
Sync Users
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No |
Response 200 OK
Schema of the response body
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
users
POST /users
Create User
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No |
Request body
{
"name": "string",
"surname": "string",
"patronymic": null,
"phone": null,
"organization_id": null,
"email": null,
"password": null,
"status": null,
"note": null,
"job_title": null,
"role": null
}
Schema of the request body
{
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"surname": {
"type": "string",
"title": "Surname"
},
"patronymic": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Patronymic"
},
"phone": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Phone"
},
"organization_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Organization Id"
},
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Email"
},
"password": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Password"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status"
},
"note": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Note"
},
"job_title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Job Title"
},
"role": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Role"
}
},
"type": "object",
"required": [
"name",
"surname",
"email"
],
"title": "CreateUserWithRoleModel"
}
Response 201 Created
{
"email": null,
"name": null,
"surname": null,
"patronymic": null,
"phone": null,
"job_title": null,
"status": null,
"photo": null,
"subsidiary_id": null,
"organization_id": null,
"policy": null,
"note": null,
"username": null,
"id": "string",
"roles": [
"string"
],
"role": "string",
"text_search": null,
"subsidiary_name": null,
"password": null
}
Schema of the response body
{
"properties": {
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Email"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name"
},
"surname": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Surname"
},
"patronymic": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Patronymic"
},
"phone": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Phone"
},
"job_title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Job Title"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status"
},
"photo": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Photo"
},
"subsidiary_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Subsidiary Id"
},
"organization_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Organization Id"
},
"policy": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Policy"
},
"note": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Note"
},
"username": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Username"
},
"id": {
"type": "string",
"title": "Id"
},
"roles": {
"items": {
"type": "string"
},
"type": "array",
"title": "Roles"
},
"role": {
"type": "string",
"title": "Role",
"default": ""
},
"text_search": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Text Search"
},
"subsidiary_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Subsidiary Name"
},
"password": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Password"
}
},
"type": "object",
"title": "SotransUserDBModel",
"description": "Represents a full Keycloak user object in SOTRANS configuration for database."
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /users
Get Users
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
assignment |
query | string | No | ||
limit |
query | integer | 200 | No | |
projection |
query | string | No | ||
search |
query | string | No | ||
skip |
query | integer | 0 | No | |
sort |
query | string | No | ||
where |
query | string | No |
Response 200 OK
{
"items": [
{
"email": null,
"name": null,
"surname": null,
"patronymic": null,
"phone": null,
"job_title": null,
"status": null,
"photo": null,
"subsidiary_id": null,
"organization_id": null,
"policy": null,
"note": null,
"username": null,
"id": "string",
"roles": [
"string"
],
"role": "string",
"text_search": null,
"subsidiary_name": null,
"password": null
}
],
"total": 0
}
Schema of the response body
{
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/SotransUserDBModel"
},
"type": "array",
"title": "Items"
},
"total": {
"type": "integer",
"title": "Total"
}
},
"type": "object",
"required": [
"items",
"total"
],
"title": "GenericGetListResponse[SotransUserDBModel]"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 400 Bad Request
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /users/{user_id}
Get User By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
projection |
query | string | No | ||
user_id |
path | string | No |
Response 200 OK
{
"email": null,
"name": null,
"surname": null,
"patronymic": null,
"phone": null,
"job_title": null,
"status": null,
"photo": null,
"subsidiary_id": null,
"organization_id": null,
"policy": null,
"note": null,
"username": null,
"id": "string",
"roles": [
"string"
],
"role": "string",
"text_search": null,
"subsidiary_name": null,
"password": null
}
Schema of the response body
{
"properties": {
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Email"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name"
},
"surname": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Surname"
},
"patronymic": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Patronymic"
},
"phone": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Phone"
},
"job_title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Job Title"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status"
},
"photo": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Photo"
},
"subsidiary_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Subsidiary Id"
},
"organization_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Organization Id"
},
"policy": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Policy"
},
"note": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Note"
},
"username": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Username"
},
"id": {
"type": "string",
"title": "Id"
},
"roles": {
"items": {
"type": "string"
},
"type": "array",
"title": "Roles"
},
"role": {
"type": "string",
"title": "Role",
"default": ""
},
"text_search": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Text Search"
},
"subsidiary_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Subsidiary Name"
},
"password": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Password"
}
},
"type": "object",
"title": "SotransUserDBModel",
"description": "Represents a full Keycloak user object in SOTRANS configuration for database."
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 404 Not Found
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
DELETE /users/{user_id}
Delete User
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
user_id |
path | string | No |
Response 204 No Content
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
PATCH /users/{user_id}
Update User
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
user_id |
path | string | No |
Request body
Schema of the request body
{
"anyOf": [
{
"$ref": "#/components/schemas/SotransKeycloakUserUpdateModel"
},
{
"$ref": "#/components/schemas/SotransKeycloakUserPublicUpdateModel"
}
],
"title": "Update Data"
}
Response 200 OK
Schema of the response body
{
"anyOf": [
{
"$ref": "#/components/schemas/SotransKeycloakUserModel"
},
{
"$ref": "#/components/schemas/SotransUserDBModel"
}
],
"title": "Response Update User Users User Id Patch"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
PATCH /users/{user_id}/roles
Update User Roles
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
user_id |
path | string | No |
Request body
{
"role": "carrier_logistician"
}
Schema of the request body
{
"properties": {
"role": {
"$ref": "#/components/schemas/SotransRole"
}
},
"type": "object",
"required": [
"role"
],
"title": "UpdateRoleModel"
}
Response 200 OK
{
"role": "carrier_logistician"
}
Schema of the response body
{
"properties": {
"role": {
"$ref": "#/components/schemas/SotransRole"
}
},
"type": "object",
"required": [
"role"
],
"title": "UpdateRoleModel"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
PATCH /users/{user_id}/subsidiary
Update Subsidiary
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
sub_id |
query | string | No | ||
user_id |
path | string | No |
Response 200 OK
{
"email": null,
"name": null,
"surname": null,
"patronymic": null,
"phone": null,
"job_title": null,
"status": null,
"photo": null,
"subsidiary_id": null,
"organization_id": null,
"policy": null,
"note": null,
"username": null,
"id": "string",
"createdTimestamp": 0,
"enabled": true,
"totp": true,
"emailVerified": true,
"disableableCredentialTypes": [
"string"
],
"requiredActions": [
"string"
],
"realmRoles": null,
"notBefore": 0,
"access": {},
"attributes": null,
"roles": [
"string"
],
"role": "string"
}
Schema of the response body
{
"properties": {
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Email"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name"
},
"surname": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Surname"
},
"patronymic": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Patronymic"
},
"phone": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Phone"
},
"job_title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Job Title"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status"
},
"photo": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Photo"
},
"subsidiary_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Subsidiary Id"
},
"organization_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Organization Id"
},
"policy": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Policy"
},
"note": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Note"
},
"username": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Username"
},
"id": {
"type": "string",
"title": "Id"
},
"createdTimestamp": {
"type": "integer",
"title": "Createdtimestamp"
},
"enabled": {
"type": "boolean",
"title": "Enabled"
},
"totp": {
"type": "boolean",
"title": "Totp"
},
"emailVerified": {
"type": "boolean",
"title": "Emailverified"
},
"disableableCredentialTypes": {
"items": {
"type": "string"
},
"type": "array",
"title": "Disableablecredentialtypes"
},
"requiredActions": {
"items": {
"type": "string"
},
"type": "array",
"title": "Requiredactions"
},
"realmRoles": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Realmroles"
},
"notBefore": {
"type": "integer",
"title": "Notbefore"
},
"access": {
"type": "object",
"title": "Access"
},
"attributes": {
"anyOf": [
{
"type": "object"
},
{
"type": "null"
}
],
"title": "Attributes"
},
"roles": {
"items": {
"type": "string"
},
"type": "array",
"title": "Roles",
"default": []
},
"role": {
"type": "string",
"title": "Role",
"default": ""
}
},
"type": "object",
"required": [
"id",
"createdTimestamp",
"enabled",
"totp",
"emailVerified",
"disableableCredentialTypes",
"requiredActions",
"notBefore",
"access"
],
"title": "SotransKeycloakUserModel",
"description": "Represents a full Keycloak user object in SOTRANS configuration"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
POST /users/webhook
Keycloak Webhook
Request body
Schema of the request body
{
"type": "object",
"title": "Data"
}
Response 200 OK
Schema of the response body
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /users/{user_id}/clients
Get Assigned To Employee Clients
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
assignment |
query | string | No | ||
limit |
query | integer | 200 | No | |
projection |
query | string | No | ||
search |
query | string | No | ||
skip |
query | integer | 0 | No | |
sort |
query | string | No | ||
user_id |
path | string | No | ||
where |
query | string | No |
Response 200 OK
{
"items": [
{
"id": "string",
"name": null,
"short_name": null,
"inn": null,
"kpp": null,
"ogrn": null,
"legal_address": null,
"actual_address": null,
"phone": null,
"email": null,
"website": null,
"code_1c": null,
"bank": null,
"bik": null,
"checking_account": null,
"correspondent_account": null,
"responsible": null,
"subsidiary": null,
"note": null,
"etag": null,
"text_search": null
}
],
"total": 0
}
Schema of the response body
{
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/ClientDBModel"
},
"type": "array",
"title": "Items"
},
"total": {
"type": "integer",
"title": "Total"
}
},
"type": "object",
"required": [
"items",
"total"
],
"title": "GenericGetListResponse[ClientDBModel]"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /users/{user_id}/orders
Get Assigned Orders To Employees
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
assignment |
query | string | No | ||
limit |
query | integer | 200 | No | |
projection |
query | string | No | ||
search |
query | string | No | ||
skip |
query | integer | 0 | No | |
sort |
query | string | No | ||
user_id |
path | string | No | ||
where |
query | string | No |
Response 200 OK
{
"items": [
{
"id": "string",
"auction_end_time": null,
"stops": null,
"peculiarities": null,
"cargo_type": null,
"truck_body": null,
"client_price": null,
"start_price": null,
"end_price": null,
"currency": null,
"currency_caption": null,
"vat_type": null,
"rate_step": null,
"status": null,
"note": null,
"external": null,
"client": null,
"assigned": null,
"carrier": null,
"driver": null,
"truck": null,
"trailer": null,
"documents": null,
"cancel_reason": null,
"etag": null,
"completed_stages": null,
"created_at": null,
"your_bid": null,
"best_bid": null,
"confirmation_end_time": null,
"reservation_end_time": null,
"short_id": null,
"deleted_at": null,
"current_stage": null,
"document_draft": null,
"start_price_km": null,
"end_price_km": null,
"route_km": null,
"text_search": null,
"updated": null
}
],
"total": 0
}
Schema of the response body
{
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/OrderDBModel"
},
"type": "array",
"title": "Items"
},
"total": {
"type": "integer",
"title": "Total"
}
},
"type": "object",
"required": [
"items",
"total"
],
"title": "GenericGetListResponse[OrderDBModel]"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
documents
POST /{collection}/{object_id}/documents
Create Document New
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
collection |
path | string | No | ||
object_id |
path | string | No |
Request body
{
"type": null,
"link": null,
"name": null,
"number": null,
"valid_until": null,
"status": null,
"note": null,
"object_id": null,
"collection": null,
"etag": null
}
Schema of the request body
{
"properties": {
"type": {
"anyOf": [
{
"$ref": "#/components/schemas/RequestDocumentType"
},
{
"$ref": "#/components/schemas/OrganizationDocumentType"
},
{
"$ref": "#/components/schemas/TruckDocumentType"
},
{
"$ref": "#/components/schemas/TrailerDocumentType"
},
{
"$ref": "#/components/schemas/DriverDocumentType"
},
{
"$ref": "#/components/schemas/UserDocumentType"
},
{
"type": "null"
}
],
"title": "Type"
},
"link": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Link"
},
"name": {
"anyOf": [
{
"type": "string",
"maxLength": 256
},
{
"type": "null"
}
],
"title": "Name"
},
"number": {
"anyOf": [
{
"type": "string",
"maxLength": 64
},
{
"type": "null"
}
],
"title": "Number"
},
"valid_until": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Valid Until"
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/DocumentStatus"
},
{
"type": "null"
}
]
},
"note": {
"anyOf": [
{
"type": "string",
"maxLength": 8192
},
{
"type": "null"
}
],
"title": "Note"
},
"object_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Object Id"
},
"collection": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Collection"
},
"etag": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Etag"
}
},
"type": "object",
"title": "DocumentUpdateModel"
}
Response 201 Created
{
"id": "string",
"type": null,
"link": null,
"name": null,
"number": null,
"valid_until": null,
"status": null,
"note": null,
"object_id": null,
"collection": null,
"etag": null,
"created_at": null,
"verification": null,
"organization_id": null,
"deleted_at": null,
"text_search": null
}
Schema of the response body
{
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"type": {
"anyOf": [
{
"$ref": "#/components/schemas/RequestDocumentType"
},
{
"$ref": "#/components/schemas/OrganizationDocumentType"
},
{
"$ref": "#/components/schemas/TruckDocumentType"
},
{
"$ref": "#/components/schemas/TrailerDocumentType"
},
{
"$ref": "#/components/schemas/DriverDocumentType"
},
{
"$ref": "#/components/schemas/UserDocumentType"
},
{
"type": "null"
}
],
"title": "Type"
},
"link": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Link"
},
"name": {
"anyOf": [
{
"type": "string",
"maxLength": 256
},
{
"type": "null"
}
],
"title": "Name"
},
"number": {
"anyOf": [
{
"type": "string",
"maxLength": 64
},
{
"type": "null"
}
],
"title": "Number"
},
"valid_until": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Valid Until"
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/DocumentStatus"
},
{
"type": "null"
}
]
},
"note": {
"anyOf": [
{
"type": "string",
"maxLength": 8192
},
{
"type": "null"
}
],
"title": "Note"
},
"object_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Object Id"
},
"collection": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Collection"
},
"etag": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Etag"
},
"created_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At"
},
"verification": {
"anyOf": [
{
"$ref": "#/components/schemas/VerificationDBModel"
},
{
"type": "null"
}
]
},
"organization_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Organization Id"
},
"deleted_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Deleted At"
},
"text_search": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Text Search"
}
},
"type": "object",
"title": "DocumentDBModel"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 400 Bad Request
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /{collection}/{object_id}/documents
Get Documents New
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
assignment |
query | string | No | ||
collection |
path | string | No | ||
limit |
query | integer | 200 | No | |
object_id |
path | string | No | ||
projection |
query | string | No | ||
search |
query | string | No | ||
skip |
query | integer | 0 | No | |
sort |
query | string | No | ||
where |
query | string | No |
Response 200 OK
{
"items": [
{
"id": "string",
"type": null,
"link": null,
"name": null,
"number": null,
"valid_until": null,
"status": null,
"note": null,
"object_id": null,
"collection": null,
"etag": null,
"created_at": null,
"verification": null,
"organization_id": null,
"deleted_at": null,
"text_search": null
}
],
"total": 0
}
Schema of the response body
{
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/DocumentDBModel"
},
"type": "array",
"title": "Items"
},
"total": {
"type": "integer",
"title": "Total"
}
},
"type": "object",
"required": [
"items",
"total"
],
"title": "GenericGetListResponse[DocumentDBModel]"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
POST /documents
Create Document
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No |
Request body
{
"type": null,
"link": "string",
"name": null,
"number": null,
"valid_until": null,
"status": null,
"note": null,
"object_id": null,
"collection": null
}
Schema of the request body
{
"properties": {
"type": {
"anyOf": [
{
"$ref": "#/components/schemas/RequestDocumentType"
},
{
"$ref": "#/components/schemas/OrganizationDocumentType"
},
{
"$ref": "#/components/schemas/TruckDocumentType"
},
{
"$ref": "#/components/schemas/TrailerDocumentType"
},
{
"$ref": "#/components/schemas/DriverDocumentType"
},
{
"$ref": "#/components/schemas/UserDocumentType"
}
],
"title": "Type"
},
"link": {
"type": "string",
"title": "Link"
},
"name": {
"anyOf": [
{
"type": "string",
"maxLength": 256
},
{
"type": "null"
}
],
"title": "Name"
},
"number": {
"anyOf": [
{
"type": "string",
"maxLength": 64
},
{
"type": "null"
}
],
"title": "Number"
},
"valid_until": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Valid Until"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentStatus"
}
],
"default": "final"
},
"note": {
"anyOf": [
{
"type": "string",
"maxLength": 8192
},
{
"type": "null"
}
],
"title": "Note"
},
"object_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Object Id"
},
"collection": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Collection"
}
},
"type": "object",
"required": [
"type",
"link"
],
"title": "DocumentCreateModel"
}
Response 201 Created
{
"id": "string",
"type": null,
"link": null,
"name": null,
"number": null,
"valid_until": null,
"status": null,
"note": null,
"object_id": null,
"collection": null,
"etag": null,
"created_at": null,
"verification": null,
"organization_id": null,
"deleted_at": null,
"text_search": null
}
Schema of the response body
{
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"type": {
"anyOf": [
{
"$ref": "#/components/schemas/RequestDocumentType"
},
{
"$ref": "#/components/schemas/OrganizationDocumentType"
},
{
"$ref": "#/components/schemas/TruckDocumentType"
},
{
"$ref": "#/components/schemas/TrailerDocumentType"
},
{
"$ref": "#/components/schemas/DriverDocumentType"
},
{
"$ref": "#/components/schemas/UserDocumentType"
},
{
"type": "null"
}
],
"title": "Type"
},
"link": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Link"
},
"name": {
"anyOf": [
{
"type": "string",
"maxLength": 256
},
{
"type": "null"
}
],
"title": "Name"
},
"number": {
"anyOf": [
{
"type": "string",
"maxLength": 64
},
{
"type": "null"
}
],
"title": "Number"
},
"valid_until": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Valid Until"
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/DocumentStatus"
},
{
"type": "null"
}
]
},
"note": {
"anyOf": [
{
"type": "string",
"maxLength": 8192
},
{
"type": "null"
}
],
"title": "Note"
},
"object_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Object Id"
},
"collection": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Collection"
},
"etag": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Etag"
},
"created_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At"
},
"verification": {
"anyOf": [
{
"$ref": "#/components/schemas/VerificationDBModel"
},
{
"type": "null"
}
]
},
"organization_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Organization Id"
},
"deleted_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Deleted At"
},
"text_search": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Text Search"
}
},
"type": "object",
"title": "DocumentDBModel"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 400 Bad Request
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /documents
Get Documents
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
assignment |
query | string | No | ||
limit |
query | integer | 200 | No | |
projection |
query | string | No | ||
search |
query | string | No | ||
skip |
query | integer | 0 | No | |
sort |
query | string | No | ||
where |
query | string | No |
Response 200 OK
{
"items": [
{
"id": "string",
"type": null,
"link": null,
"name": null,
"number": null,
"valid_until": null,
"status": null,
"note": null,
"object_id": null,
"collection": null,
"etag": null,
"created_at": null,
"verification": null,
"organization_id": null,
"deleted_at": null,
"text_search": null
}
],
"total": 0
}
Schema of the response body
{
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/DocumentDBModel"
},
"type": "array",
"title": "Items"
},
"total": {
"type": "integer",
"title": "Total"
}
},
"type": "object",
"required": [
"items",
"total"
],
"title": "GenericGetListResponse[DocumentDBModel]"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /documents/{document_id}
Document Details
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
document_id |
path | string | No | ||
projection |
query | string | No |
Response 200 OK
{
"id": "string",
"type": null,
"link": null,
"name": null,
"number": null,
"valid_until": null,
"status": null,
"note": null,
"object_id": null,
"collection": null,
"etag": null,
"created_at": null,
"verification": null,
"organization_id": null,
"deleted_at": null,
"text_search": null
}
Schema of the response body
{
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"type": {
"anyOf": [
{
"$ref": "#/components/schemas/RequestDocumentType"
},
{
"$ref": "#/components/schemas/OrganizationDocumentType"
},
{
"$ref": "#/components/schemas/TruckDocumentType"
},
{
"$ref": "#/components/schemas/TrailerDocumentType"
},
{
"$ref": "#/components/schemas/DriverDocumentType"
},
{
"$ref": "#/components/schemas/UserDocumentType"
},
{
"type": "null"
}
],
"title": "Type"
},
"link": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Link"
},
"name": {
"anyOf": [
{
"type": "string",
"maxLength": 256
},
{
"type": "null"
}
],
"title": "Name"
},
"number": {
"anyOf": [
{
"type": "string",
"maxLength": 64
},
{
"type": "null"
}
],
"title": "Number"
},
"valid_until": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Valid Until"
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/DocumentStatus"
},
{
"type": "null"
}
]
},
"note": {
"anyOf": [
{
"type": "string",
"maxLength": 8192
},
{
"type": "null"
}
],
"title": "Note"
},
"object_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Object Id"
},
"collection": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Collection"
},
"etag": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Etag"
},
"created_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At"
},
"verification": {
"anyOf": [
{
"$ref": "#/components/schemas/VerificationDBModel"
},
{
"type": "null"
}
]
},
"organization_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Organization Id"
},
"deleted_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Deleted At"
},
"text_search": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Text Search"
}
},
"type": "object",
"title": "DocumentDBModel"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 404 Not Found
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
DELETE /documents/{document_id}
Remove Document
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
document_id |
path | string | No |
Request body
Schema of the request body
{
"anyOf": [
{
"$ref": "#/components/schemas/DocumentUpdateModel"
},
{
"type": "null"
}
],
"title": "Resource With Etag"
}
Response 204 No Content
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 404 Not Found
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
PATCH /documents/{doc_id}
Update Document
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
doc_id |
path | string | No |
Request body
{
"type": null,
"link": null,
"name": null,
"number": null,
"valid_until": null,
"status": null,
"note": null,
"object_id": null,
"collection": null,
"etag": null
}
Schema of the request body
{
"properties": {
"type": {
"anyOf": [
{
"$ref": "#/components/schemas/RequestDocumentType"
},
{
"$ref": "#/components/schemas/OrganizationDocumentType"
},
{
"$ref": "#/components/schemas/TruckDocumentType"
},
{
"$ref": "#/components/schemas/TrailerDocumentType"
},
{
"$ref": "#/components/schemas/DriverDocumentType"
},
{
"$ref": "#/components/schemas/UserDocumentType"
},
{
"type": "null"
}
],
"title": "Type"
},
"link": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Link"
},
"name": {
"anyOf": [
{
"type": "string",
"maxLength": 256
},
{
"type": "null"
}
],
"title": "Name"
},
"number": {
"anyOf": [
{
"type": "string",
"maxLength": 64
},
{
"type": "null"
}
],
"title": "Number"
},
"valid_until": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Valid Until"
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/DocumentStatus"
},
{
"type": "null"
}
]
},
"note": {
"anyOf": [
{
"type": "string",
"maxLength": 8192
},
{
"type": "null"
}
],
"title": "Note"
},
"object_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Object Id"
},
"collection": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Collection"
},
"etag": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Etag"
}
},
"type": "object",
"title": "DocumentUpdateModel"
}
Response 200 OK
{
"id": "string",
"type": null,
"link": null,
"name": null,
"number": null,
"valid_until": null,
"status": null,
"note": null,
"object_id": null,
"collection": null,
"etag": null,
"created_at": null,
"verification": null,
"organization_id": null,
"deleted_at": null,
"text_search": null
}
Schema of the response body
{
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"type": {
"anyOf": [
{
"$ref": "#/components/schemas/RequestDocumentType"
},
{
"$ref": "#/components/schemas/OrganizationDocumentType"
},
{
"$ref": "#/components/schemas/TruckDocumentType"
},
{
"$ref": "#/components/schemas/TrailerDocumentType"
},
{
"$ref": "#/components/schemas/DriverDocumentType"
},
{
"$ref": "#/components/schemas/UserDocumentType"
},
{
"type": "null"
}
],
"title": "Type"
},
"link": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Link"
},
"name": {
"anyOf": [
{
"type": "string",
"maxLength": 256
},
{
"type": "null"
}
],
"title": "Name"
},
"number": {
"anyOf": [
{
"type": "string",
"maxLength": 64
},
{
"type": "null"
}
],
"title": "Number"
},
"valid_until": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Valid Until"
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/DocumentStatus"
},
{
"type": "null"
}
]
},
"note": {
"anyOf": [
{
"type": "string",
"maxLength": 8192
},
{
"type": "null"
}
],
"title": "Note"
},
"object_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Object Id"
},
"collection": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Collection"
},
"etag": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Etag"
},
"created_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At"
},
"verification": {
"anyOf": [
{
"$ref": "#/components/schemas/VerificationDBModel"
},
{
"type": "null"
}
]
},
"organization_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Organization Id"
},
"deleted_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Deleted At"
},
"text_search": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Text Search"
}
},
"type": "object",
"title": "DocumentDBModel"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 404 Not Found
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 406 Not Acceptable
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
organizations
POST /organizations
Create Organization
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No |
Request body
Schema of the request body
{
"allOf": [
{
"$ref": "#/components/schemas/OrganizationCreateModel"
}
],
"examples": [
{
"inn": "843643634653"
}
],
"title": "Item"
}
Response 201 Created
{
"id": "string",
"name": null,
"short_name": null,
"head": null,
"ownership_type": null,
"logo": null,
"legal_address": null,
"factual_address": null,
"phone": null,
"email": null,
"kpp": null,
"ogrn": null,
"taxation_type": null,
"bank": null,
"bik": null,
"ifns_code": null,
"registration_date": null,
"contact_user": null,
"documents": null,
"inn": null,
"inn_verification_status": null,
"etag": null,
"is_active": null,
"owner": null,
"created_at": null,
"full_verification": true,
"text_search": null,
"verification": null,
"carriers_rating": null,
"carriers_rating_missed": null,
"activity_rating": null
}
Schema of the response body
{
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"name": {
"anyOf": [
{
"type": "string",
"maxLength": 128
},
{
"type": "null"
}
],
"title": "Name"
},
"short_name": {
"anyOf": [
{
"type": "string",
"maxLength": 60
},
{
"type": "null"
}
],
"title": "Short Name"
},
"head": {
"anyOf": [
{
"type": "string",
"maxLength": 100
},
{
"type": "null"
}
],
"title": "Head"
},
"ownership_type": {
"anyOf": [
{
"type": "string",
"maxLength": 40
},
{
"type": "null"
}
],
"title": "Ownership Type"
},
"logo": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Logo"
},
"legal_address": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"title": "Legal Address"
},
"factual_address": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"title": "Factual Address"
},
"phone": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Phone"
},
"email": {
"anyOf": [
{
"type": "string",
"maxLength": 80
},
{
"type": "null"
}
],
"title": "Email"
},
"kpp": {
"anyOf": [
{
"type": "string",
"maxLength": 9
},
{
"type": "null"
}
],
"title": "Kpp"
},
"ogrn": {
"anyOf": [
{
"type": "string",
"maxLength": 13
},
{
"type": "null"
}
],
"title": "Ogrn"
},
"taxation_type": {
"anyOf": [
{
"type": "string",
"maxLength": 4
},
{
"type": "null"
}
],
"title": "Taxation Type"
},
"bank": {
"anyOf": [
{
"type": "string",
"maxLength": 80
},
{
"type": "null"
}
],
"title": "Bank"
},
"bik": {
"anyOf": [
{
"type": "string",
"maxLength": 11
},
{
"type": "null"
}
],
"title": "Bik"
},
"ifns_code": {
"anyOf": [
{
"type": "string",
"maxLength": 4
},
{
"type": "null"
}
],
"title": "Ifns Code"
},
"registration_date": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Registration Date"
},
"contact_user": {
"anyOf": [
{
"$ref": "#/components/schemas/SotransUserDBModel"
},
{
"type": "null"
}
]
},
"documents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/DocumentDBModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Documents"
},
"inn": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Inn"
},
"inn_verification_status": {
"anyOf": [
{
"$ref": "#/components/schemas/InnVerificationStatus"
},
{
"type": "null"
}
]
},
"etag": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Etag"
},
"is_active": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Is Active"
},
"owner": {
"anyOf": [
{
"$ref": "#/components/schemas/SotransUserDBModel"
},
{
"type": "null"
}
]
},
"created_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At"
},
"full_verification": {
"type": "boolean",
"title": "Full Verification",
"default": false
},
"text_search": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Text Search"
},
"verification": {
"anyOf": [
{
"$ref": "#/components/schemas/VerificationDBModel"
},
{
"type": "null"
}
]
},
"carriers_rating": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Carriers Rating"
},
"carriers_rating_missed": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Carriers Rating Missed"
},
"activity_rating": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Activity Rating"
}
},
"type": "object",
"title": "OrganizationDBModel"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /organizations
Get Organizations
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
assignment |
query | string | No | ||
limit |
query | integer | 200 | No | |
projection |
query | string | No | ||
search |
query | string | No | ||
skip |
query | integer | 0 | No | |
sort |
query | string | No | ||
where |
query | string | No |
Response 200 OK
{
"items": [
{
"id": "string",
"name": null,
"short_name": null,
"head": null,
"ownership_type": null,
"logo": null,
"legal_address": null,
"factual_address": null,
"phone": null,
"email": null,
"kpp": null,
"ogrn": null,
"taxation_type": null,
"bank": null,
"bik": null,
"ifns_code": null,
"registration_date": null,
"contact_user": null,
"documents": null,
"inn": null,
"inn_verification_status": null,
"etag": null,
"is_active": null,
"owner": null,
"created_at": null,
"full_verification": true,
"text_search": null,
"verification": null,
"carriers_rating": null,
"carriers_rating_missed": null,
"activity_rating": null
}
],
"total": 0
}
Schema of the response body
{
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/OrganizationDBModel"
},
"type": "array",
"title": "Items"
},
"total": {
"type": "integer",
"title": "Total"
}
},
"type": "object",
"required": [
"items",
"total"
],
"title": "GenericGetListResponse[OrganizationDBModel]"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /organizations/{org_id}
Get Organization
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
org_id |
path | string | No | ||
projection |
query | string | No |
Response 200 OK
{
"id": "string",
"name": null,
"short_name": null,
"head": null,
"ownership_type": null,
"logo": null,
"legal_address": null,
"factual_address": null,
"phone": null,
"email": null,
"kpp": null,
"ogrn": null,
"taxation_type": null,
"bank": null,
"bik": null,
"ifns_code": null,
"registration_date": null,
"contact_user": null,
"documents": null,
"inn": null,
"inn_verification_status": null,
"etag": null,
"is_active": null,
"owner": null,
"created_at": null,
"full_verification": true,
"text_search": null,
"verification": null,
"carriers_rating": null,
"carriers_rating_missed": null,
"activity_rating": null
}
Schema of the response body
{
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"name": {
"anyOf": [
{
"type": "string",
"maxLength": 128
},
{
"type": "null"
}
],
"title": "Name"
},
"short_name": {
"anyOf": [
{
"type": "string",
"maxLength": 60
},
{
"type": "null"
}
],
"title": "Short Name"
},
"head": {
"anyOf": [
{
"type": "string",
"maxLength": 100
},
{
"type": "null"
}
],
"title": "Head"
},
"ownership_type": {
"anyOf": [
{
"type": "string",
"maxLength": 40
},
{
"type": "null"
}
],
"title": "Ownership Type"
},
"logo": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Logo"
},
"legal_address": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"title": "Legal Address"
},
"factual_address": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"title": "Factual Address"
},
"phone": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Phone"
},
"email": {
"anyOf": [
{
"type": "string",
"maxLength": 80
},
{
"type": "null"
}
],
"title": "Email"
},
"kpp": {
"anyOf": [
{
"type": "string",
"maxLength": 9
},
{
"type": "null"
}
],
"title": "Kpp"
},
"ogrn": {
"anyOf": [
{
"type": "string",
"maxLength": 13
},
{
"type": "null"
}
],
"title": "Ogrn"
},
"taxation_type": {
"anyOf": [
{
"type": "string",
"maxLength": 4
},
{
"type": "null"
}
],
"title": "Taxation Type"
},
"bank": {
"anyOf": [
{
"type": "string",
"maxLength": 80
},
{
"type": "null"
}
],
"title": "Bank"
},
"bik": {
"anyOf": [
{
"type": "string",
"maxLength": 11
},
{
"type": "null"
}
],
"title": "Bik"
},
"ifns_code": {
"anyOf": [
{
"type": "string",
"maxLength": 4
},
{
"type": "null"
}
],
"title": "Ifns Code"
},
"registration_date": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Registration Date"
},
"contact_user": {
"anyOf": [
{
"$ref": "#/components/schemas/SotransUserDBModel"
},
{
"type": "null"
}
]
},
"documents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/DocumentDBModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Documents"
},
"inn": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Inn"
},
"inn_verification_status": {
"anyOf": [
{
"$ref": "#/components/schemas/InnVerificationStatus"
},
{
"type": "null"
}
]
},
"etag": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Etag"
},
"is_active": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Is Active"
},
"owner": {
"anyOf": [
{
"$ref": "#/components/schemas/SotransUserDBModel"
},
{
"type": "null"
}
]
},
"created_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At"
},
"full_verification": {
"type": "boolean",
"title": "Full Verification",
"default": false
},
"text_search": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Text Search"
},
"verification": {
"anyOf": [
{
"$ref": "#/components/schemas/VerificationDBModel"
},
{
"type": "null"
}
]
},
"carriers_rating": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Carriers Rating"
},
"carriers_rating_missed": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Carriers Rating Missed"
},
"activity_rating": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Activity Rating"
}
},
"type": "object",
"title": "OrganizationDBModel"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 404 Not Found
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
PATCH /organizations/{org_id}
Update Organization
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
org_id |
path | string | No |
Request body
{
"name": null,
"short_name": null,
"head": null,
"ownership_type": null,
"logo": null,
"legal_address": null,
"factual_address": null,
"phone": null,
"email": null,
"kpp": null,
"ogrn": null,
"taxation_type": null,
"bank": null,
"bik": null,
"ifns_code": null,
"registration_date": null,
"contact_user": null,
"documents": null,
"inn": null,
"inn_verification_status": null,
"etag": null,
"is_active": null
}
Schema of the request body
{
"properties": {
"name": {
"anyOf": [
{
"type": "string",
"maxLength": 128
},
{
"type": "null"
}
],
"title": "Name"
},
"short_name": {
"anyOf": [
{
"type": "string",
"maxLength": 60
},
{
"type": "null"
}
],
"title": "Short Name"
},
"head": {
"anyOf": [
{
"type": "string",
"maxLength": 100
},
{
"type": "null"
}
],
"title": "Head"
},
"ownership_type": {
"anyOf": [
{
"type": "string",
"maxLength": 40
},
{
"type": "null"
}
],
"title": "Ownership Type"
},
"logo": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Logo"
},
"legal_address": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"title": "Legal Address"
},
"factual_address": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"title": "Factual Address"
},
"phone": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Phone"
},
"email": {
"anyOf": [
{
"type": "string",
"maxLength": 80
},
{
"type": "null"
}
],
"title": "Email"
},
"kpp": {
"anyOf": [
{
"type": "string",
"maxLength": 9
},
{
"type": "null"
}
],
"title": "Kpp"
},
"ogrn": {
"anyOf": [
{
"type": "string",
"maxLength": 13
},
{
"type": "null"
}
],
"title": "Ogrn"
},
"taxation_type": {
"anyOf": [
{
"type": "string",
"maxLength": 4
},
{
"type": "null"
}
],
"title": "Taxation Type"
},
"bank": {
"anyOf": [
{
"type": "string",
"maxLength": 80
},
{
"type": "null"
}
],
"title": "Bank"
},
"bik": {
"anyOf": [
{
"type": "string",
"maxLength": 11
},
{
"type": "null"
}
],
"title": "Bik"
},
"ifns_code": {
"anyOf": [
{
"type": "string",
"maxLength": 4
},
{
"type": "null"
}
],
"title": "Ifns Code"
},
"registration_date": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Registration Date"
},
"contact_user": {
"anyOf": [
{
"$ref": "#/components/schemas/InsertByUUIDModel"
},
{
"type": "null"
}
]
},
"documents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/DocumentCreateModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Documents"
},
"inn": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Inn"
},
"inn_verification_status": {
"anyOf": [
{
"$ref": "#/components/schemas/InnVerificationStatus"
},
{
"type": "null"
}
]
},
"etag": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Etag"
},
"is_active": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Is Active"
}
},
"type": "object",
"title": "OrganizationUpdateModel"
}
Response 200 OK
{
"id": "string",
"name": null,
"short_name": null,
"head": null,
"ownership_type": null,
"logo": null,
"legal_address": null,
"factual_address": null,
"phone": null,
"email": null,
"kpp": null,
"ogrn": null,
"taxation_type": null,
"bank": null,
"bik": null,
"ifns_code": null,
"registration_date": null,
"contact_user": null,
"documents": null,
"inn": null,
"inn_verification_status": null,
"etag": null,
"is_active": null,
"owner": null,
"created_at": null,
"full_verification": true,
"text_search": null,
"verification": null,
"carriers_rating": null,
"carriers_rating_missed": null,
"activity_rating": null
}
Schema of the response body
{
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"name": {
"anyOf": [
{
"type": "string",
"maxLength": 128
},
{
"type": "null"
}
],
"title": "Name"
},
"short_name": {
"anyOf": [
{
"type": "string",
"maxLength": 60
},
{
"type": "null"
}
],
"title": "Short Name"
},
"head": {
"anyOf": [
{
"type": "string",
"maxLength": 100
},
{
"type": "null"
}
],
"title": "Head"
},
"ownership_type": {
"anyOf": [
{
"type": "string",
"maxLength": 40
},
{
"type": "null"
}
],
"title": "Ownership Type"
},
"logo": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Logo"
},
"legal_address": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"title": "Legal Address"
},
"factual_address": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"title": "Factual Address"
},
"phone": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Phone"
},
"email": {
"anyOf": [
{
"type": "string",
"maxLength": 80
},
{
"type": "null"
}
],
"title": "Email"
},
"kpp": {
"anyOf": [
{
"type": "string",
"maxLength": 9
},
{
"type": "null"
}
],
"title": "Kpp"
},
"ogrn": {
"anyOf": [
{
"type": "string",
"maxLength": 13
},
{
"type": "null"
}
],
"title": "Ogrn"
},
"taxation_type": {
"anyOf": [
{
"type": "string",
"maxLength": 4
},
{
"type": "null"
}
],
"title": "Taxation Type"
},
"bank": {
"anyOf": [
{
"type": "string",
"maxLength": 80
},
{
"type": "null"
}
],
"title": "Bank"
},
"bik": {
"anyOf": [
{
"type": "string",
"maxLength": 11
},
{
"type": "null"
}
],
"title": "Bik"
},
"ifns_code": {
"anyOf": [
{
"type": "string",
"maxLength": 4
},
{
"type": "null"
}
],
"title": "Ifns Code"
},
"registration_date": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Registration Date"
},
"contact_user": {
"anyOf": [
{
"$ref": "#/components/schemas/SotransUserDBModel"
},
{
"type": "null"
}
]
},
"documents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/DocumentDBModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Documents"
},
"inn": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Inn"
},
"inn_verification_status": {
"anyOf": [
{
"$ref": "#/components/schemas/InnVerificationStatus"
},
{
"type": "null"
}
]
},
"etag": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Etag"
},
"is_active": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Is Active"
},
"owner": {
"anyOf": [
{
"$ref": "#/components/schemas/SotransUserDBModel"
},
{
"type": "null"
}
]
},
"created_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At"
},
"full_verification": {
"type": "boolean",
"title": "Full Verification",
"default": false
},
"text_search": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Text Search"
},
"verification": {
"anyOf": [
{
"$ref": "#/components/schemas/VerificationDBModel"
},
{
"type": "null"
}
]
},
"carriers_rating": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Carriers Rating"
},
"carriers_rating_missed": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Carriers Rating Missed"
},
"activity_rating": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Activity Rating"
}
},
"type": "object",
"title": "OrganizationDBModel"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
PATCH /organizations/{org_id}/inn
Update Inn
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
org_id |
path | string | No |
Request body
{
"inn": "string"
}
Schema of the request body
{
"properties": {
"inn": {
"type": "string",
"title": "Inn"
}
},
"type": "object",
"required": [
"inn"
],
"title": "UpdateINNPayload"
}
Response 200 OK
{
"id": "string",
"name": null,
"short_name": null,
"head": null,
"ownership_type": null,
"logo": null,
"legal_address": null,
"factual_address": null,
"phone": null,
"email": null,
"kpp": null,
"ogrn": null,
"taxation_type": null,
"bank": null,
"bik": null,
"ifns_code": null,
"registration_date": null,
"contact_user": null,
"documents": null,
"inn": null,
"inn_verification_status": null,
"etag": null,
"is_active": null,
"owner": null,
"created_at": null,
"full_verification": true,
"text_search": null,
"verification": null,
"carriers_rating": null,
"carriers_rating_missed": null,
"activity_rating": null
}
Schema of the response body
{
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"name": {
"anyOf": [
{
"type": "string",
"maxLength": 128
},
{
"type": "null"
}
],
"title": "Name"
},
"short_name": {
"anyOf": [
{
"type": "string",
"maxLength": 60
},
{
"type": "null"
}
],
"title": "Short Name"
},
"head": {
"anyOf": [
{
"type": "string",
"maxLength": 100
},
{
"type": "null"
}
],
"title": "Head"
},
"ownership_type": {
"anyOf": [
{
"type": "string",
"maxLength": 40
},
{
"type": "null"
}
],
"title": "Ownership Type"
},
"logo": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Logo"
},
"legal_address": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"title": "Legal Address"
},
"factual_address": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"title": "Factual Address"
},
"phone": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Phone"
},
"email": {
"anyOf": [
{
"type": "string",
"maxLength": 80
},
{
"type": "null"
}
],
"title": "Email"
},
"kpp": {
"anyOf": [
{
"type": "string",
"maxLength": 9
},
{
"type": "null"
}
],
"title": "Kpp"
},
"ogrn": {
"anyOf": [
{
"type": "string",
"maxLength": 13
},
{
"type": "null"
}
],
"title": "Ogrn"
},
"taxation_type": {
"anyOf": [
{
"type": "string",
"maxLength": 4
},
{
"type": "null"
}
],
"title": "Taxation Type"
},
"bank": {
"anyOf": [
{
"type": "string",
"maxLength": 80
},
{
"type": "null"
}
],
"title": "Bank"
},
"bik": {
"anyOf": [
{
"type": "string",
"maxLength": 11
},
{
"type": "null"
}
],
"title": "Bik"
},
"ifns_code": {
"anyOf": [
{
"type": "string",
"maxLength": 4
},
{
"type": "null"
}
],
"title": "Ifns Code"
},
"registration_date": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Registration Date"
},
"contact_user": {
"anyOf": [
{
"$ref": "#/components/schemas/SotransUserDBModel"
},
{
"type": "null"
}
]
},
"documents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/DocumentDBModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Documents"
},
"inn": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Inn"
},
"inn_verification_status": {
"anyOf": [
{
"$ref": "#/components/schemas/InnVerificationStatus"
},
{
"type": "null"
}
]
},
"etag": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Etag"
},
"is_active": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Is Active"
},
"owner": {
"anyOf": [
{
"$ref": "#/components/schemas/SotransUserDBModel"
},
{
"type": "null"
}
]
},
"created_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At"
},
"full_verification": {
"type": "boolean",
"title": "Full Verification",
"default": false
},
"text_search": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Text Search"
},
"verification": {
"anyOf": [
{
"$ref": "#/components/schemas/VerificationDBModel"
},
{
"type": "null"
}
]
},
"carriers_rating": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Carriers Rating"
},
"carriers_rating_missed": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Carriers Rating Missed"
},
"activity_rating": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Activity Rating"
}
},
"type": "object",
"title": "OrganizationDBModel"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /organizations/{org_id}/drivers
Get Organizations Drivers
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
assignment |
query | string | No | ||
limit |
query | integer | 200 | No | |
org_id |
path | string | No | ||
projection |
query | string | No | ||
search |
query | string | No | ||
skip |
query | integer | 0 | No | |
sort |
query | string | No | ||
where |
query | string | No |
Response 200 OK
{
"items": [
{
"id": "string",
"surname": null,
"name": null,
"patronymic": null,
"status": null,
"inn": null,
"photo": null,
"phone": null,
"note": null,
"code_1c": null,
"drivers_license": null,
"passport": null,
"documents": null,
"etag": null,
"verification": null,
"is_active": null,
"organization_id": "string",
"created_at": null,
"text_search": null
}
],
"total": 0
}
Schema of the response body
{
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/DriverDBModel"
},
"type": "array",
"title": "Items"
},
"total": {
"type": "integer",
"title": "Total"
}
},
"type": "object",
"required": [
"items",
"total"
],
"title": "GenericGetListResponse[DriverDBModel]"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /organizations/{org_id}/trucks
Get Organizations Trucks
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
assignment |
query | string | No | ||
limit |
query | integer | 200 | No | |
org_id |
path | string | No | ||
projection |
query | string | No | ||
search |
query | string | No | ||
skip |
query | integer | 0 | No | |
sort |
query | string | No | ||
where |
query | string | No |
Response 200 OK
{
"items": [
{
"id": "string",
"code_1c": null,
"registration_country": null,
"brand": null,
"model": null,
"license_plate": null,
"sts_number": null,
"sts_series": null,
"registration_date": null,
"vin_number": null,
"ownership_type": null,
"body": null,
"status": null,
"note": null,
"documents": null,
"etag": null,
"verification": null,
"is_active": null,
"organization_id": "string",
"created_at": null,
"text_search": null,
"truck_type": null
}
],
"total": 0
}
Schema of the response body
{
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/TruckDBModel"
},
"type": "array",
"title": "Items"
},
"total": {
"type": "integer",
"title": "Total"
}
},
"type": "object",
"required": [
"items",
"total"
],
"title": "GenericGetListResponse[TruckDBModel]"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /organizations/{org_id}/trailers
Get Organizations Trailers
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
assignment |
query | string | No | ||
limit |
query | integer | 200 | No | |
org_id |
path | string | No | ||
projection |
query | string | No | ||
search |
query | string | No | ||
skip |
query | integer | 0 | No | |
sort |
query | string | No | ||
where |
query | string | No |
Response 200 OK
{
"items": [
{
"id": "string",
"code_1c": null,
"registration_country": null,
"brand": null,
"model": null,
"license_plate": null,
"sts_number": null,
"sts_series": null,
"registration_date": null,
"vin_number": null,
"ownership_type": null,
"body": null,
"status": null,
"note": null,
"documents": null,
"etag": null,
"verification": null,
"is_active": null,
"organization_id": "string",
"created_at": null,
"text_search": null
}
],
"total": 0
}
Schema of the response body
{
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/TrailerDBModel"
},
"type": "array",
"title": "Items"
},
"total": {
"type": "integer",
"title": "Total"
}
},
"type": "object",
"required": [
"items",
"total"
],
"title": "GenericGetListResponse[TrailerDBModel]"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /organizations/{org_id}/completion
Get Org Completion
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
org_id |
path | string | No |
Response 200 OK
{
"total_percentage": 10.12,
"missing": null
}
Schema of the response body
{
"properties": {
"total_percentage": {
"type": "number",
"title": "Total Percentage"
},
"missing": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Missing"
}
},
"type": "object",
"required": [
"total_percentage"
],
"title": "ProfileCompletionResponse"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
drivers
POST /drivers
Create Driver
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No |
Request body
{
"surname": "string",
"name": "string",
"patronymic": null,
"status": null,
"inn": "string",
"photo": null,
"phone": null,
"note": null,
"code_1c": null,
"drivers_license": {
"number": "string",
"country": "string",
"valid_from": "2022-04-13T15:42:05.901Z",
"valid_to": "2022-04-13T15:42:05.901Z",
"issued_by": "string"
},
"passport": {
"series": "string",
"number": "string",
"issue_date": "2022-04-13T15:42:05.901Z",
"issued_by": "string",
"birthdate": "2022-04-13T15:42:05.901Z",
"birthplace": "string",
"registration_address": "string",
"country": "string"
},
"documents": null
}
Schema of the request body
{
"properties": {
"surname": {
"type": "string",
"maxLength": 30,
"title": "Surname"
},
"name": {
"type": "string",
"maxLength": 30,
"title": "Name"
},
"patronymic": {
"anyOf": [
{
"type": "string",
"maxLength": 40
},
{
"type": "null"
}
],
"title": "Patronymic"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/DriverStatus"
}
],
"default": "ready"
},
"inn": {
"type": "string",
"maxLength": 20,
"title": "Inn"
},
"photo": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Photo"
},
"phone": {
"anyOf": [
{
"type": "string",
"maxLength": 64,
"minLength": 7
},
{
"type": "null"
}
],
"title": "Phone"
},
"note": {
"anyOf": [
{
"type": "string",
"maxLength": 8192
},
{
"type": "null"
}
],
"title": "Note"
},
"code_1c": {
"anyOf": [
{
"type": "string",
"maxLength": 100
},
{
"type": "null"
}
],
"title": "Code 1C"
},
"drivers_license": {
"$ref": "#/components/schemas/DriversLicenseModel"
},
"passport": {
"$ref": "#/components/schemas/PassportModel"
},
"documents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/DocumentCreateModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Documents"
}
},
"type": "object",
"required": [
"surname",
"name",
"inn",
"drivers_license",
"passport"
],
"title": "DriverCreateModel"
}
Response 201 Created
{
"id": "string",
"surname": null,
"name": null,
"patronymic": null,
"status": null,
"inn": null,
"photo": null,
"phone": null,
"note": null,
"code_1c": null,
"drivers_license": null,
"passport": null,
"documents": null,
"etag": null,
"verification": null,
"is_active": null,
"organization_id": "string",
"created_at": null,
"text_search": null
}
Schema of the response body
{
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"surname": {
"anyOf": [
{
"type": "string",
"maxLength": 30
},
{
"type": "null"
}
],
"title": "Surname"
},
"name": {
"anyOf": [
{
"type": "string",
"maxLength": 30
},
{
"type": "null"
}
],
"title": "Name"
},
"patronymic": {
"anyOf": [
{
"type": "string",
"maxLength": 40
},
{
"type": "null"
}
],
"title": "Patronymic"
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/DriverStatus"
},
{
"type": "null"
}
]
},
"inn": {
"anyOf": [
{
"type": "string",
"maxLength": 20
},
{
"type": "null"
}
],
"title": "Inn"
},
"photo": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Photo"
},
"phone": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Phone"
},
"note": {
"anyOf": [
{
"type": "string",
"maxLength": 8192
},
{
"type": "null"
}
],
"title": "Note"
},
"code_1c": {
"anyOf": [
{
"type": "string",
"maxLength": 100
},
{
"type": "null"
}
],
"title": "Code 1C"
},
"drivers_license": {
"anyOf": [
{
"$ref": "#/components/schemas/LicenseDBModel"
},
{
"type": "null"
}
]
},
"passport": {
"anyOf": [
{
"$ref": "#/components/schemas/PassportDBModel"
},
{
"type": "null"
}
]
},
"documents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/DocumentDBModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Documents"
},
"etag": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Etag"
},
"verification": {
"anyOf": [
{
"$ref": "#/components/schemas/VerificationDBModel"
},
{
"type": "null"
}
]
},
"is_active": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Is Active"
},
"organization_id": {
"type": "string",
"title": "Organization Id"
},
"created_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At"
},
"text_search": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Text Search"
}
},
"type": "object",
"title": "DriverDBModel"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /drivers
Get Drivers
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
assignment |
query | string | No | ||
limit |
query | integer | 200 | No | |
projection |
query | string | No | ||
search |
query | string | No | ||
skip |
query | integer | 0 | No | |
sort |
query | string | No | ||
where |
query | string | No |
Response 200 OK
{
"items": [
{
"id": "string",
"surname": null,
"name": null,
"patronymic": null,
"status": null,
"inn": null,
"photo": null,
"phone": null,
"note": null,
"code_1c": null,
"drivers_license": null,
"passport": null,
"documents": null,
"etag": null,
"verification": null,
"is_active": null,
"organization_id": "string",
"created_at": null,
"text_search": null
}
],
"total": 0
}
Schema of the response body
{
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/DriverDBModel"
},
"type": "array",
"title": "Items"
},
"total": {
"type": "integer",
"title": "Total"
}
},
"type": "object",
"required": [
"items",
"total"
],
"title": "GenericGetListResponse[DriverDBModel]"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /drivers/{driver_id}
Get Driver
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
driver_id |
path | string | No |
Response 200 OK
{
"id": "string",
"surname": null,
"name": null,
"patronymic": null,
"status": null,
"inn": null,
"photo": null,
"phone": null,
"note": null,
"code_1c": null,
"drivers_license": null,
"passport": null,
"documents": null,
"etag": null,
"verification": null,
"is_active": null,
"organization_id": "string",
"created_at": null,
"text_search": null
}
Schema of the response body
{
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"surname": {
"anyOf": [
{
"type": "string",
"maxLength": 30
},
{
"type": "null"
}
],
"title": "Surname"
},
"name": {
"anyOf": [
{
"type": "string",
"maxLength": 30
},
{
"type": "null"
}
],
"title": "Name"
},
"patronymic": {
"anyOf": [
{
"type": "string",
"maxLength": 40
},
{
"type": "null"
}
],
"title": "Patronymic"
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/DriverStatus"
},
{
"type": "null"
}
]
},
"inn": {
"anyOf": [
{
"type": "string",
"maxLength": 20
},
{
"type": "null"
}
],
"title": "Inn"
},
"photo": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Photo"
},
"phone": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Phone"
},
"note": {
"anyOf": [
{
"type": "string",
"maxLength": 8192
},
{
"type": "null"
}
],
"title": "Note"
},
"code_1c": {
"anyOf": [
{
"type": "string",
"maxLength": 100
},
{
"type": "null"
}
],
"title": "Code 1C"
},
"drivers_license": {
"anyOf": [
{
"$ref": "#/components/schemas/LicenseDBModel"
},
{
"type": "null"
}
]
},
"passport": {
"anyOf": [
{
"$ref": "#/components/schemas/PassportDBModel"
},
{
"type": "null"
}
]
},
"documents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/DocumentDBModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Documents"
},
"etag": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Etag"
},
"verification": {
"anyOf": [
{
"$ref": "#/components/schemas/VerificationDBModel"
},
{
"type": "null"
}
]
},
"is_active": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Is Active"
},
"organization_id": {
"type": "string",
"title": "Organization Id"
},
"created_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At"
},
"text_search": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Text Search"
}
},
"type": "object",
"title": "DriverDBModel"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 404 Not Found
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
PATCH /drivers/{driver_id}
Update Driver
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
driver_id |
path | string | No |
Request body
{
"surname": null,
"name": null,
"patronymic": null,
"status": null,
"inn": null,
"photo": null,
"phone": null,
"note": null,
"code_1c": null,
"drivers_license": null,
"passport": null,
"documents": null,
"etag": null
}
Schema of the request body
{
"properties": {
"surname": {
"anyOf": [
{
"type": "string",
"maxLength": 30
},
{
"type": "null"
}
],
"title": "Surname"
},
"name": {
"anyOf": [
{
"type": "string",
"maxLength": 30
},
{
"type": "null"
}
],
"title": "Name"
},
"patronymic": {
"anyOf": [
{
"type": "string",
"maxLength": 40
},
{
"type": "null"
}
],
"title": "Patronymic"
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/DriverStatus"
},
{
"type": "null"
}
]
},
"inn": {
"anyOf": [
{
"type": "string",
"maxLength": 20
},
{
"type": "null"
}
],
"title": "Inn"
},
"photo": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Photo"
},
"phone": {
"anyOf": [
{
"type": "string",
"maxLength": 64,
"minLength": 7
},
{
"type": "null"
}
],
"title": "Phone"
},
"note": {
"anyOf": [
{
"type": "string",
"maxLength": 8192
},
{
"type": "null"
}
],
"title": "Note"
},
"code_1c": {
"anyOf": [
{
"type": "string",
"maxLength": 100
},
{
"type": "null"
}
],
"title": "Code 1C"
},
"drivers_license": {
"anyOf": [
{
"$ref": "#/components/schemas/DriversLicenseModel"
},
{
"type": "null"
}
]
},
"passport": {
"anyOf": [
{
"$ref": "#/components/schemas/PassportModel"
},
{
"type": "null"
}
]
},
"documents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/DocumentCreateModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Documents"
},
"etag": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Etag"
}
},
"type": "object",
"title": "DriverUpdateModel"
}
Response 200 OK
{
"id": "string",
"surname": null,
"name": null,
"patronymic": null,
"status": null,
"inn": null,
"photo": null,
"phone": null,
"note": null,
"code_1c": null,
"drivers_license": null,
"passport": null,
"documents": null,
"etag": null,
"verification": null,
"is_active": null,
"organization_id": "string",
"created_at": null,
"text_search": null
}
Schema of the response body
{
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"surname": {
"anyOf": [
{
"type": "string",
"maxLength": 30
},
{
"type": "null"
}
],
"title": "Surname"
},
"name": {
"anyOf": [
{
"type": "string",
"maxLength": 30
},
{
"type": "null"
}
],
"title": "Name"
},
"patronymic": {
"anyOf": [
{
"type": "string",
"maxLength": 40
},
{
"type": "null"
}
],
"title": "Patronymic"
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/DriverStatus"
},
{
"type": "null"
}
]
},
"inn": {
"anyOf": [
{
"type": "string",
"maxLength": 20
},
{
"type": "null"
}
],
"title": "Inn"
},
"photo": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Photo"
},
"phone": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Phone"
},
"note": {
"anyOf": [
{
"type": "string",
"maxLength": 8192
},
{
"type": "null"
}
],
"title": "Note"
},
"code_1c": {
"anyOf": [
{
"type": "string",
"maxLength": 100
},
{
"type": "null"
}
],
"title": "Code 1C"
},
"drivers_license": {
"anyOf": [
{
"$ref": "#/components/schemas/LicenseDBModel"
},
{
"type": "null"
}
]
},
"passport": {
"anyOf": [
{
"$ref": "#/components/schemas/PassportDBModel"
},
{
"type": "null"
}
]
},
"documents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/DocumentDBModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Documents"
},
"etag": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Etag"
},
"verification": {
"anyOf": [
{
"$ref": "#/components/schemas/VerificationDBModel"
},
{
"type": "null"
}
]
},
"is_active": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Is Active"
},
"organization_id": {
"type": "string",
"title": "Organization Id"
},
"created_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At"
},
"text_search": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Text Search"
}
},
"type": "object",
"title": "DriverDBModel"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 404 Not Found
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
DELETE /drivers/{driver_id}
Delete Driver
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
driver_id |
path | string | No |
Request body
Schema of the request body
{
"anyOf": [
{
"$ref": "#/components/schemas/DriverUpdateModel"
},
{
"type": "null"
}
],
"title": "Resource With Etag"
}
Response 204 No Content
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 404 Not Found
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
trucks
POST /trucks
Create Truck
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No |
Request body
{
"code_1c": null,
"registration_country": "string",
"brand": null,
"model": null,
"license_plate": "string",
"sts_number": "string",
"sts_series": "string",
"registration_date": null,
"vin_number": null,
"ownership_type": "own",
"body": {
"body_type": null,
"loading_type": null,
"weight": null,
"volume": null
},
"status": null,
"note": null,
"documents": null,
"truck_type": "van_truck"
}
Schema of the request body
{
"properties": {
"code_1c": {
"anyOf": [
{
"type": "string",
"maxLength": 100
},
{
"type": "null"
}
],
"title": "Code 1C"
},
"registration_country": {
"$ref": "#/components/schemas/VehicleRegistrationCountry"
},
"brand": {
"anyOf": [
{
"type": "string",
"maxLength": 40
},
{
"type": "null"
}
],
"title": "Brand"
},
"model": {
"anyOf": [
{
"type": "string",
"maxLength": 60
},
{
"type": "null"
}
],
"title": "Model"
},
"license_plate": {
"type": "string",
"title": "License Plate"
},
"sts_number": {
"type": "string",
"maxLength": 6,
"title": "Sts Number"
},
"sts_series": {
"type": "string",
"maxLength": 4,
"title": "Sts Series"
},
"registration_date": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Registration Date"
},
"vin_number": {
"anyOf": [
{
"type": "string",
"maxLength": 17
},
{
"type": "null"
}
],
"title": "Vin Number"
},
"ownership_type": {
"$ref": "#/components/schemas/OwnershipType"
},
"body": {
"$ref": "#/components/schemas/BodySettingsModel"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/TruckStatus"
}
],
"default": "ready"
},
"note": {
"anyOf": [
{
"type": "string",
"maxLength": 8192
},
{
"type": "null"
}
],
"title": "Note"
},
"documents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/DocumentCreateModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Documents"
},
"truck_type": {
"$ref": "#/components/schemas/TruckType"
}
},
"type": "object",
"required": [
"registration_country",
"license_plate",
"sts_number",
"sts_series",
"ownership_type",
"body",
"truck_type"
],
"title": "TruckCreateModel"
}
Response 201 Created
{
"id": "string",
"code_1c": null,
"registration_country": null,
"brand": null,
"model": null,
"license_plate": null,
"sts_number": null,
"sts_series": null,
"registration_date": null,
"vin_number": null,
"ownership_type": null,
"body": null,
"status": null,
"note": null,
"documents": null,
"etag": null,
"verification": null,
"is_active": null,
"organization_id": "string",
"created_at": null,
"text_search": null,
"truck_type": null
}
Schema of the response body
{
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"code_1c": {
"anyOf": [
{
"type": "string",
"maxLength": 100
},
{
"type": "null"
}
],
"title": "Code 1C"
},
"registration_country": {
"anyOf": [
{
"$ref": "#/components/schemas/VehicleRegistrationCountry"
},
{
"type": "null"
}
]
},
"brand": {
"anyOf": [
{
"type": "string",
"maxLength": 40
},
{
"type": "null"
}
],
"title": "Brand"
},
"model": {
"anyOf": [
{
"type": "string",
"maxLength": 60
},
{
"type": "null"
}
],
"title": "Model"
},
"license_plate": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Plate"
},
"sts_number": {
"anyOf": [
{
"type": "string",
"maxLength": 6
},
{
"type": "null"
}
],
"title": "Sts Number"
},
"sts_series": {
"anyOf": [
{
"type": "string",
"maxLength": 4
},
{
"type": "null"
}
],
"title": "Sts Series"
},
"registration_date": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Registration Date"
},
"vin_number": {
"anyOf": [
{
"type": "string",
"maxLength": 17
},
{
"type": "null"
}
],
"title": "Vin Number"
},
"ownership_type": {
"anyOf": [
{
"$ref": "#/components/schemas/OwnershipType"
},
{
"type": "null"
}
]
},
"body": {
"anyOf": [
{
"$ref": "#/components/schemas/BodySettingsModel"
},
{
"type": "null"
}
]
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/TruckStatus"
},
{
"type": "null"
}
]
},
"note": {
"anyOf": [
{
"type": "string",
"maxLength": 8192
},
{
"type": "null"
}
],
"title": "Note"
},
"documents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/DocumentDBModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Documents"
},
"etag": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Etag"
},
"verification": {
"anyOf": [
{
"$ref": "#/components/schemas/VerificationDBModel"
},
{
"type": "null"
}
]
},
"is_active": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Is Active"
},
"organization_id": {
"type": "string",
"title": "Organization Id"
},
"created_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At"
},
"text_search": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Text Search"
},
"truck_type": {
"anyOf": [
{
"$ref": "#/components/schemas/TruckType"
},
{
"type": "null"
}
]
}
},
"type": "object",
"title": "TruckDBModel"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /trucks
Get Trucks
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
assignment |
query | string | No | ||
limit |
query | integer | 200 | No | |
projection |
query | string | No | ||
search |
query | string | No | ||
skip |
query | integer | 0 | No | |
sort |
query | string | No | ||
where |
query | string | No |
Response 200 OK
{
"items": [
{
"id": "string",
"code_1c": null,
"registration_country": null,
"brand": null,
"model": null,
"license_plate": null,
"sts_number": null,
"sts_series": null,
"registration_date": null,
"vin_number": null,
"ownership_type": null,
"body": null,
"status": null,
"note": null,
"documents": null,
"etag": null,
"verification": null,
"is_active": null,
"organization_id": "string",
"created_at": null,
"text_search": null,
"truck_type": null
}
],
"total": 0
}
Schema of the response body
{
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/TruckDBModel"
},
"type": "array",
"title": "Items"
},
"total": {
"type": "integer",
"title": "Total"
}
},
"type": "object",
"required": [
"items",
"total"
],
"title": "GenericGetListResponse[TruckDBModel]"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /trucks/properties
Get Types Mapping
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No |
Response 200 OK
Schema of the response body
{
"additionalProperties": {
"items": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"type": "array"
},
"type": "object",
"title": "Response Get Types Mapping Trucks Properties Get"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
GET /trucks/{truck_id}
Get Truck
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
truck_id |
path | string | No |
Response 200 OK
{
"id": "string",
"code_1c": null,
"registration_country": null,
"brand": null,
"model": null,
"license_plate": null,
"sts_number": null,
"sts_series": null,
"registration_date": null,
"vin_number": null,
"ownership_type": null,
"body": null,
"status": null,
"note": null,
"documents": null,
"etag": null,
"verification": null,
"is_active": null,
"organization_id": "string",
"created_at": null,
"text_search": null,
"truck_type": null
}
Schema of the response body
{
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"code_1c": {
"anyOf": [
{
"type": "string",
"maxLength": 100
},
{
"type": "null"
}
],
"title": "Code 1C"
},
"registration_country": {
"anyOf": [
{
"$ref": "#/components/schemas/VehicleRegistrationCountry"
},
{
"type": "null"
}
]
},
"brand": {
"anyOf": [
{
"type": "string",
"maxLength": 40
},
{
"type": "null"
}
],
"title": "Brand"
},
"model": {
"anyOf": [
{
"type": "string",
"maxLength": 60
},
{
"type": "null"
}
],
"title": "Model"
},
"license_plate": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Plate"
},
"sts_number": {
"anyOf": [
{
"type": "string",
"maxLength": 6
},
{
"type": "null"
}
],
"title": "Sts Number"
},
"sts_series": {
"anyOf": [
{
"type": "string",
"maxLength": 4
},
{
"type": "null"
}
],
"title": "Sts Series"
},
"registration_date": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Registration Date"
},
"vin_number": {
"anyOf": [
{
"type": "string",
"maxLength": 17
},
{
"type": "null"
}
],
"title": "Vin Number"
},
"ownership_type": {
"anyOf": [
{
"$ref": "#/components/schemas/OwnershipType"
},
{
"type": "null"
}
]
},
"body": {
"anyOf": [
{
"$ref": "#/components/schemas/BodySettingsModel"
},
{
"type": "null"
}
]
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/TruckStatus"
},
{
"type": "null"
}
]
},
"note": {
"anyOf": [
{
"type": "string",
"maxLength": 8192
},
{
"type": "null"
}
],
"title": "Note"
},
"documents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/DocumentDBModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Documents"
},
"etag": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Etag"
},
"verification": {
"anyOf": [
{
"$ref": "#/components/schemas/VerificationDBModel"
},
{
"type": "null"
}
]
},
"is_active": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Is Active"
},
"organization_id": {
"type": "string",
"title": "Organization Id"
},
"created_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At"
},
"text_search": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Text Search"
},
"truck_type": {
"anyOf": [
{
"$ref": "#/components/schemas/TruckType"
},
{
"type": "null"
}
]
}
},
"type": "object",
"title": "TruckDBModel"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
PATCH /trucks/{truck_id}
Update Truck
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
truck_id |
path | string | No |
Request body
{
"code_1c": null,
"registration_country": null,
"brand": null,
"model": null,
"license_plate": null,
"sts_number": null,
"sts_series": null,
"registration_date": null,
"vin_number": null,
"ownership_type": null,
"body": null,
"status": null,
"note": null,
"documents": null,
"truck_type": null,
"etag": null
}
Schema of the request body
{
"properties": {
"code_1c": {
"anyOf": [
{
"type": "string",
"maxLength": 100
},
{
"type": "null"
}
],
"title": "Code 1C"
},
"registration_country": {
"anyOf": [
{
"$ref": "#/components/schemas/VehicleRegistrationCountry"
},
{
"type": "null"
}
]
},
"brand": {
"anyOf": [
{
"type": "string",
"maxLength": 40
},
{
"type": "null"
}
],
"title": "Brand"
},
"model": {
"anyOf": [
{
"type": "string",
"maxLength": 60
},
{
"type": "null"
}
],
"title": "Model"
},
"license_plate": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Plate"
},
"sts_number": {
"anyOf": [
{
"type": "string",
"maxLength": 6
},
{
"type": "null"
}
],
"title": "Sts Number"
},
"sts_series": {
"anyOf": [
{
"type": "string",
"maxLength": 4
},
{
"type": "null"
}
],
"title": "Sts Series"
},
"registration_date": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Registration Date"
},
"vin_number": {
"anyOf": [
{
"type": "string",
"maxLength": 17
},
{
"type": "null"
}
],
"title": "Vin Number"
},
"ownership_type": {
"anyOf": [
{
"$ref": "#/components/schemas/OwnershipType"
},
{
"type": "null"
}
]
},
"body": {
"anyOf": [
{
"$ref": "#/components/schemas/BodySettingsModel"
},
{
"type": "null"
}
]
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/TruckStatus"
},
{
"type": "null"
}
]
},
"note": {
"anyOf": [
{
"type": "string",
"maxLength": 8192
},
{
"type": "null"
}
],
"title": "Note"
},
"documents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/DocumentCreateModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Documents"
},
"truck_type": {
"anyOf": [
{
"$ref": "#/components/schemas/TruckType"
},
{
"type": "null"
}
]
},
"etag": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Etag"
}
},
"type": "object",
"title": "TruckUpdateModel"
}
Response 200 OK
{
"id": "string",
"code_1c": null,
"registration_country": null,
"brand": null,
"model": null,
"license_plate": null,
"sts_number": null,
"sts_series": null,
"registration_date": null,
"vin_number": null,
"ownership_type": null,
"body": null,
"status": null,
"note": null,
"documents": null,
"etag": null,
"verification": null,
"is_active": null,
"organization_id": "string",
"created_at": null,
"text_search": null,
"truck_type": null
}
Schema of the response body
{
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"code_1c": {
"anyOf": [
{
"type": "string",
"maxLength": 100
},
{
"type": "null"
}
],
"title": "Code 1C"
},
"registration_country": {
"anyOf": [
{
"$ref": "#/components/schemas/VehicleRegistrationCountry"
},
{
"type": "null"
}
]
},
"brand": {
"anyOf": [
{
"type": "string",
"maxLength": 40
},
{
"type": "null"
}
],
"title": "Brand"
},
"model": {
"anyOf": [
{
"type": "string",
"maxLength": 60
},
{
"type": "null"
}
],
"title": "Model"
},
"license_plate": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Plate"
},
"sts_number": {
"anyOf": [
{
"type": "string",
"maxLength": 6
},
{
"type": "null"
}
],
"title": "Sts Number"
},
"sts_series": {
"anyOf": [
{
"type": "string",
"maxLength": 4
},
{
"type": "null"
}
],
"title": "Sts Series"
},
"registration_date": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Registration Date"
},
"vin_number": {
"anyOf": [
{
"type": "string",
"maxLength": 17
},
{
"type": "null"
}
],
"title": "Vin Number"
},
"ownership_type": {
"anyOf": [
{
"$ref": "#/components/schemas/OwnershipType"
},
{
"type": "null"
}
]
},
"body": {
"anyOf": [
{
"$ref": "#/components/schemas/BodySettingsModel"
},
{
"type": "null"
}
]
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/TruckStatus"
},
{
"type": "null"
}
]
},
"note": {
"anyOf": [
{
"type": "string",
"maxLength": 8192
},
{
"type": "null"
}
],
"title": "Note"
},
"documents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/DocumentDBModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Documents"
},
"etag": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Etag"
},
"verification": {
"anyOf": [
{
"$ref": "#/components/schemas/VerificationDBModel"
},
{
"type": "null"
}
]
},
"is_active": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Is Active"
},
"organization_id": {
"type": "string",
"title": "Organization Id"
},
"created_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At"
},
"text_search": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Text Search"
},
"truck_type": {
"anyOf": [
{
"$ref": "#/components/schemas/TruckType"
},
{
"type": "null"
}
]
}
},
"type": "object",
"title": "TruckDBModel"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
DELETE /trucks/{truck_id}
Delete Truck
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
truck_id |
path | string | No |
Request body
Schema of the request body
{
"anyOf": [
{
"$ref": "#/components/schemas/TruckUpdateModel"
},
{
"type": "null"
}
],
"title": "Resource With Etag"
}
Response 204 No Content
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
trailers
POST /trailers
Create Trailer
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No |
Request body
{
"code_1c": null,
"registration_country": "string",
"brand": null,
"model": null,
"license_plate": "string",
"sts_number": "string",
"sts_series": "string",
"registration_date": null,
"vin_number": null,
"ownership_type": "own",
"body": {
"body_type": null,
"loading_type": null,
"weight": null,
"volume": null
},
"status": null,
"note": null,
"documents": null
}
Schema of the request body
{
"properties": {
"code_1c": {
"anyOf": [
{
"type": "string",
"maxLength": 100
},
{
"type": "null"
}
],
"title": "Code 1C"
},
"registration_country": {
"$ref": "#/components/schemas/VehicleRegistrationCountry"
},
"brand": {
"anyOf": [
{
"type": "string",
"maxLength": 40
},
{
"type": "null"
}
],
"title": "Brand"
},
"model": {
"anyOf": [
{
"type": "string",
"maxLength": 60
},
{
"type": "null"
}
],
"title": "Model"
},
"license_plate": {
"type": "string",
"title": "License Plate"
},
"sts_number": {
"type": "string",
"maxLength": 6,
"title": "Sts Number"
},
"sts_series": {
"type": "string",
"maxLength": 4,
"title": "Sts Series"
},
"registration_date": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Registration Date"
},
"vin_number": {
"anyOf": [
{
"type": "string",
"maxLength": 17
},
{
"type": "null"
}
],
"title": "Vin Number"
},
"ownership_type": {
"$ref": "#/components/schemas/OwnershipType"
},
"body": {
"$ref": "#/components/schemas/BodySettingsModel"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/TruckStatus"
}
],
"default": "ready"
},
"note": {
"anyOf": [
{
"type": "string",
"maxLength": 8192
},
{
"type": "null"
}
],
"title": "Note"
},
"documents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/DocumentCreateModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Documents"
}
},
"type": "object",
"required": [
"registration_country",
"license_plate",
"sts_number",
"sts_series",
"ownership_type",
"body"
],
"title": "TrailerCreateModel"
}
Response 201 Created
{
"id": "string",
"code_1c": null,
"registration_country": null,
"brand": null,
"model": null,
"license_plate": null,
"sts_number": null,
"sts_series": null,
"registration_date": null,
"vin_number": null,
"ownership_type": null,
"body": null,
"status": null,
"note": null,
"documents": null,
"etag": null,
"verification": null,
"is_active": null,
"organization_id": "string",
"created_at": null,
"text_search": null
}
Schema of the response body
{
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"code_1c": {
"anyOf": [
{
"type": "string",
"maxLength": 100
},
{
"type": "null"
}
],
"title": "Code 1C"
},
"registration_country": {
"anyOf": [
{
"$ref": "#/components/schemas/VehicleRegistrationCountry"
},
{
"type": "null"
}
]
},
"brand": {
"anyOf": [
{
"type": "string",
"maxLength": 40
},
{
"type": "null"
}
],
"title": "Brand"
},
"model": {
"anyOf": [
{
"type": "string",
"maxLength": 60
},
{
"type": "null"
}
],
"title": "Model"
},
"license_plate": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Plate"
},
"sts_number": {
"anyOf": [
{
"type": "string",
"maxLength": 6
},
{
"type": "null"
}
],
"title": "Sts Number"
},
"sts_series": {
"anyOf": [
{
"type": "string",
"maxLength": 4
},
{
"type": "null"
}
],
"title": "Sts Series"
},
"registration_date": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Registration Date"
},
"vin_number": {
"anyOf": [
{
"type": "string",
"maxLength": 17
},
{
"type": "null"
}
],
"title": "Vin Number"
},
"ownership_type": {
"anyOf": [
{
"$ref": "#/components/schemas/OwnershipType"
},
{
"type": "null"
}
]
},
"body": {
"anyOf": [
{
"$ref": "#/components/schemas/BodySettingsModel"
},
{
"type": "null"
}
]
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/TruckStatus"
},
{
"type": "null"
}
]
},
"note": {
"anyOf": [
{
"type": "string",
"maxLength": 8192
},
{
"type": "null"
}
],
"title": "Note"
},
"documents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/DocumentDBModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Documents"
},
"etag": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Etag"
},
"verification": {
"anyOf": [
{
"$ref": "#/components/schemas/VerificationDBModel"
},
{
"type": "null"
}
]
},
"is_active": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Is Active"
},
"organization_id": {
"type": "string",
"title": "Organization Id"
},
"created_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At"
},
"text_search": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Text Search"
}
},
"type": "object",
"title": "TrailerDBModel"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /trailers
Get Trailers
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
assignment |
query | string | No | ||
limit |
query | integer | 200 | No | |
projection |
query | string | No | ||
search |
query | string | No | ||
skip |
query | integer | 0 | No | |
sort |
query | string | No | ||
where |
query | string | No |
Response 200 OK
{
"items": [
{
"id": "string",
"code_1c": null,
"registration_country": null,
"brand": null,
"model": null,
"license_plate": null,
"sts_number": null,
"sts_series": null,
"registration_date": null,
"vin_number": null,
"ownership_type": null,
"body": null,
"status": null,
"note": null,
"documents": null,
"etag": null,
"verification": null,
"is_active": null,
"organization_id": "string",
"created_at": null,
"text_search": null
}
],
"total": 0
}
Schema of the response body
{
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/TrailerDBModel"
},
"type": "array",
"title": "Items"
},
"total": {
"type": "integer",
"title": "Total"
}
},
"type": "object",
"required": [
"items",
"total"
],
"title": "GenericGetListResponse[TrailerDBModel]"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /trailers/{trailer_id}
Get Trailer
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
trailer_id |
path | string | No |
Response 200 OK
{
"id": "string",
"code_1c": null,
"registration_country": null,
"brand": null,
"model": null,
"license_plate": null,
"sts_number": null,
"sts_series": null,
"registration_date": null,
"vin_number": null,
"ownership_type": null,
"body": null,
"status": null,
"note": null,
"documents": null,
"etag": null,
"verification": null,
"is_active": null,
"organization_id": "string",
"created_at": null,
"text_search": null
}
Schema of the response body
{
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"code_1c": {
"anyOf": [
{
"type": "string",
"maxLength": 100
},
{
"type": "null"
}
],
"title": "Code 1C"
},
"registration_country": {
"anyOf": [
{
"$ref": "#/components/schemas/VehicleRegistrationCountry"
},
{
"type": "null"
}
]
},
"brand": {
"anyOf": [
{
"type": "string",
"maxLength": 40
},
{
"type": "null"
}
],
"title": "Brand"
},
"model": {
"anyOf": [
{
"type": "string",
"maxLength": 60
},
{
"type": "null"
}
],
"title": "Model"
},
"license_plate": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Plate"
},
"sts_number": {
"anyOf": [
{
"type": "string",
"maxLength": 6
},
{
"type": "null"
}
],
"title": "Sts Number"
},
"sts_series": {
"anyOf": [
{
"type": "string",
"maxLength": 4
},
{
"type": "null"
}
],
"title": "Sts Series"
},
"registration_date": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Registration Date"
},
"vin_number": {
"anyOf": [
{
"type": "string",
"maxLength": 17
},
{
"type": "null"
}
],
"title": "Vin Number"
},
"ownership_type": {
"anyOf": [
{
"$ref": "#/components/schemas/OwnershipType"
},
{
"type": "null"
}
]
},
"body": {
"anyOf": [
{
"$ref": "#/components/schemas/BodySettingsModel"
},
{
"type": "null"
}
]
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/TruckStatus"
},
{
"type": "null"
}
]
},
"note": {
"anyOf": [
{
"type": "string",
"maxLength": 8192
},
{
"type": "null"
}
],
"title": "Note"
},
"documents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/DocumentDBModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Documents"
},
"etag": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Etag"
},
"verification": {
"anyOf": [
{
"$ref": "#/components/schemas/VerificationDBModel"
},
{
"type": "null"
}
]
},
"is_active": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Is Active"
},
"organization_id": {
"type": "string",
"title": "Organization Id"
},
"created_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At"
},
"text_search": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Text Search"
}
},
"type": "object",
"title": "TrailerDBModel"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 404 Not Found
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
PATCH /trailers/{trailer_id}
Update Trailer
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
trailer_id |
path | string | No |
Request body
{
"code_1c": null,
"registration_country": null,
"brand": null,
"model": null,
"license_plate": null,
"sts_number": null,
"sts_series": null,
"registration_date": null,
"vin_number": null,
"ownership_type": null,
"body": null,
"status": null,
"note": null,
"documents": null,
"etag": null
}
Schema of the request body
{
"properties": {
"code_1c": {
"anyOf": [
{
"type": "string",
"maxLength": 100
},
{
"type": "null"
}
],
"title": "Code 1C"
},
"registration_country": {
"anyOf": [
{
"$ref": "#/components/schemas/VehicleRegistrationCountry"
},
{
"type": "null"
}
]
},
"brand": {
"anyOf": [
{
"type": "string",
"maxLength": 40
},
{
"type": "null"
}
],
"title": "Brand"
},
"model": {
"anyOf": [
{
"type": "string",
"maxLength": 60
},
{
"type": "null"
}
],
"title": "Model"
},
"license_plate": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Plate"
},
"sts_number": {
"anyOf": [
{
"type": "string",
"maxLength": 6
},
{
"type": "null"
}
],
"title": "Sts Number"
},
"sts_series": {
"anyOf": [
{
"type": "string",
"maxLength": 4
},
{
"type": "null"
}
],
"title": "Sts Series"
},
"registration_date": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Registration Date"
},
"vin_number": {
"anyOf": [
{
"type": "string",
"maxLength": 17
},
{
"type": "null"
}
],
"title": "Vin Number"
},
"ownership_type": {
"anyOf": [
{
"$ref": "#/components/schemas/OwnershipType"
},
{
"type": "null"
}
]
},
"body": {
"anyOf": [
{
"$ref": "#/components/schemas/BodySettingsModel"
},
{
"type": "null"
}
]
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/TruckStatus"
},
{
"type": "null"
}
]
},
"note": {
"anyOf": [
{
"type": "string",
"maxLength": 8192
},
{
"type": "null"
}
],
"title": "Note"
},
"documents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/DocumentCreateModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Documents"
},
"etag": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Etag"
}
},
"type": "object",
"title": "TrailerUpdateModel"
}
Response 200 OK
{
"id": "string",
"code_1c": null,
"registration_country": null,
"brand": null,
"model": null,
"license_plate": null,
"sts_number": null,
"sts_series": null,
"registration_date": null,
"vin_number": null,
"ownership_type": null,
"body": null,
"status": null,
"note": null,
"documents": null,
"etag": null,
"verification": null,
"is_active": null,
"organization_id": "string",
"created_at": null,
"text_search": null
}
Schema of the response body
{
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"code_1c": {
"anyOf": [
{
"type": "string",
"maxLength": 100
},
{
"type": "null"
}
],
"title": "Code 1C"
},
"registration_country": {
"anyOf": [
{
"$ref": "#/components/schemas/VehicleRegistrationCountry"
},
{
"type": "null"
}
]
},
"brand": {
"anyOf": [
{
"type": "string",
"maxLength": 40
},
{
"type": "null"
}
],
"title": "Brand"
},
"model": {
"anyOf": [
{
"type": "string",
"maxLength": 60
},
{
"type": "null"
}
],
"title": "Model"
},
"license_plate": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Plate"
},
"sts_number": {
"anyOf": [
{
"type": "string",
"maxLength": 6
},
{
"type": "null"
}
],
"title": "Sts Number"
},
"sts_series": {
"anyOf": [
{
"type": "string",
"maxLength": 4
},
{
"type": "null"
}
],
"title": "Sts Series"
},
"registration_date": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Registration Date"
},
"vin_number": {
"anyOf": [
{
"type": "string",
"maxLength": 17
},
{
"type": "null"
}
],
"title": "Vin Number"
},
"ownership_type": {
"anyOf": [
{
"$ref": "#/components/schemas/OwnershipType"
},
{
"type": "null"
}
]
},
"body": {
"anyOf": [
{
"$ref": "#/components/schemas/BodySettingsModel"
},
{
"type": "null"
}
]
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/TruckStatus"
},
{
"type": "null"
}
]
},
"note": {
"anyOf": [
{
"type": "string",
"maxLength": 8192
},
{
"type": "null"
}
],
"title": "Note"
},
"documents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/DocumentDBModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Documents"
},
"etag": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Etag"
},
"verification": {
"anyOf": [
{
"$ref": "#/components/schemas/VerificationDBModel"
},
{
"type": "null"
}
]
},
"is_active": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Is Active"
},
"organization_id": {
"type": "string",
"title": "Organization Id"
},
"created_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At"
},
"text_search": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Text Search"
}
},
"type": "object",
"title": "TrailerDBModel"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
DELETE /trailers/{trailer_id}
Delete Trailer
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
trailer_id |
path | string | No |
Request body
Schema of the request body
{
"anyOf": [
{
"$ref": "#/components/schemas/TrailerUpdateModel"
},
{
"type": "null"
}
],
"title": "Resource With Etag"
}
Response 204 No Content
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 404 Not Found
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
clients
POST /clients
Create Client
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No |
Request body
{
"name": null,
"short_name": null,
"inn": "string",
"kpp": null,
"ogrn": null,
"legal_address": null,
"actual_address": null,
"phone": null,
"email": null,
"website": null,
"code_1c": null,
"bank": null,
"bik": null,
"checking_account": null,
"correspondent_account": null,
"responsible": null,
"subsidiary": null,
"note": null
}
Schema of the request body
{
"properties": {
"name": {
"anyOf": [
{
"type": "string",
"maxLength": 80
},
{
"type": "null"
}
],
"title": "Name"
},
"short_name": {
"anyOf": [
{
"type": "string",
"maxLength": 40
},
{
"type": "null"
}
],
"title": "Short Name"
},
"inn": {
"type": "string",
"title": "Inn"
},
"kpp": {
"anyOf": [
{
"type": "string",
"maxLength": 32
},
{
"type": "null"
}
],
"title": "Kpp"
},
"ogrn": {
"anyOf": [
{
"type": "string",
"maxLength": 32
},
{
"type": "null"
}
],
"title": "Ogrn"
},
"legal_address": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"title": "Legal Address"
},
"actual_address": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"title": "Actual Address"
},
"phone": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Phone"
},
"email": {
"anyOf": [
{
"type": "string",
"format": "email"
},
{
"type": "null"
}
],
"title": "Email"
},
"website": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Website"
},
"code_1c": {
"anyOf": [
{
"type": "string",
"maxLength": 100
},
{
"type": "null"
}
],
"title": "Code 1C"
},
"bank": {
"anyOf": [
{
"type": "string",
"maxLength": 64
},
{
"type": "null"
}
],
"title": "Bank"
},
"bik": {
"anyOf": [
{
"type": "string",
"maxLength": 11
},
{
"type": "null"
}
],
"title": "Bik"
},
"checking_account": {
"anyOf": [
{
"type": "string",
"maxLength": 32
},
{
"type": "null"
}
],
"title": "Checking Account"
},
"correspondent_account": {
"anyOf": [
{
"type": "string",
"maxLength": 32
},
{
"type": "null"
}
],
"title": "Correspondent Account"
},
"responsible": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/InsertByUUIDModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Responsible"
},
"subsidiary": {
"anyOf": [
{
"$ref": "#/components/schemas/InsertByOIDModel"
},
{
"type": "null"
}
]
},
"note": {
"anyOf": [
{
"type": "string",
"maxLength": 8192
},
{
"type": "null"
}
],
"title": "Note"
}
},
"type": "object",
"required": [
"inn"
],
"title": "ClientCreateModel"
}
Response 201 Created
{
"id": "string",
"name": null,
"short_name": null,
"inn": null,
"kpp": null,
"ogrn": null,
"legal_address": null,
"actual_address": null,
"phone": null,
"email": null,
"website": null,
"code_1c": null,
"bank": null,
"bik": null,
"checking_account": null,
"correspondent_account": null,
"responsible": null,
"subsidiary": null,
"note": null,
"etag": null,
"text_search": null
}
Schema of the response body
{
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"name": {
"anyOf": [
{
"type": "string",
"maxLength": 80
},
{
"type": "null"
}
],
"title": "Name"
},
"short_name": {
"anyOf": [
{
"type": "string",
"maxLength": 40
},
{
"type": "null"
}
],
"title": "Short Name"
},
"inn": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Inn"
},
"kpp": {
"anyOf": [
{
"type": "string",
"maxLength": 32
},
{
"type": "null"
}
],
"title": "Kpp"
},
"ogrn": {
"anyOf": [
{
"type": "string",
"maxLength": 32
},
{
"type": "null"
}
],
"title": "Ogrn"
},
"legal_address": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"title": "Legal Address"
},
"actual_address": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"title": "Actual Address"
},
"phone": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Phone"
},
"email": {
"anyOf": [
{
"type": "string",
"format": "email"
},
{
"type": "null"
}
],
"title": "Email"
},
"website": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Website"
},
"code_1c": {
"anyOf": [
{
"type": "string",
"maxLength": 100
},
{
"type": "null"
}
],
"title": "Code 1C"
},
"bank": {
"anyOf": [
{
"type": "string",
"maxLength": 64
},
{
"type": "null"
}
],
"title": "Bank"
},
"bik": {
"anyOf": [
{
"type": "string",
"maxLength": 11
},
{
"type": "null"
}
],
"title": "Bik"
},
"checking_account": {
"anyOf": [
{
"type": "string",
"maxLength": 32
},
{
"type": "null"
}
],
"title": "Checking Account"
},
"correspondent_account": {
"anyOf": [
{
"type": "string",
"maxLength": 32
},
{
"type": "null"
}
],
"title": "Correspondent Account"
},
"responsible": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/SotransUserDBModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Responsible"
},
"subsidiary": {
"anyOf": [
{
"$ref": "#/components/schemas/SubsidiaryDBModel"
},
{
"type": "null"
}
]
},
"note": {
"anyOf": [
{
"type": "string",
"maxLength": 8192
},
{
"type": "null"
}
],
"title": "Note"
},
"etag": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Etag"
},
"text_search": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Text Search"
}
},
"type": "object",
"title": "ClientDBModel"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /clients
Get Clients List
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
assignment |
query | string | No | ||
limit |
query | integer | 200 | No | |
projection |
query | string | No | ||
search |
query | string | No | ||
skip |
query | integer | 0 | No | |
sort |
query | string | No | ||
where |
query | string | No |
Response 200 OK
{
"items": [
{
"id": "string",
"name": null,
"short_name": null,
"inn": null,
"kpp": null,
"ogrn": null,
"legal_address": null,
"actual_address": null,
"phone": null,
"email": null,
"website": null,
"code_1c": null,
"bank": null,
"bik": null,
"checking_account": null,
"correspondent_account": null,
"responsible": null,
"subsidiary": null,
"note": null,
"etag": null,
"text_search": null
}
],
"total": 0
}
Schema of the response body
{
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/ClientDBModel"
},
"type": "array",
"title": "Items"
},
"total": {
"type": "integer",
"title": "Total"
}
},
"type": "object",
"required": [
"items",
"total"
],
"title": "GenericGetListResponse[ClientDBModel]"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
PATCH /clients/{client_id}
Change Client Data
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
client_id |
path | string | No |
Request body
{
"name": null,
"short_name": null,
"inn": null,
"kpp": null,
"ogrn": null,
"legal_address": null,
"actual_address": null,
"phone": null,
"email": null,
"website": null,
"code_1c": null,
"bank": null,
"bik": null,
"checking_account": null,
"correspondent_account": null,
"responsible": null,
"subsidiary": null,
"note": null,
"etag": null
}
Schema of the request body
{
"properties": {
"name": {
"anyOf": [
{
"type": "string",
"maxLength": 80
},
{
"type": "null"
}
],
"title": "Name"
},
"short_name": {
"anyOf": [
{
"type": "string",
"maxLength": 40
},
{
"type": "null"
}
],
"title": "Short Name"
},
"inn": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Inn"
},
"kpp": {
"anyOf": [
{
"type": "string",
"maxLength": 32
},
{
"type": "null"
}
],
"title": "Kpp"
},
"ogrn": {
"anyOf": [
{
"type": "string",
"maxLength": 32
},
{
"type": "null"
}
],
"title": "Ogrn"
},
"legal_address": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"title": "Legal Address"
},
"actual_address": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"title": "Actual Address"
},
"phone": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Phone"
},
"email": {
"anyOf": [
{
"type": "string",
"format": "email"
},
{
"type": "null"
}
],
"title": "Email"
},
"website": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Website"
},
"code_1c": {
"anyOf": [
{
"type": "string",
"maxLength": 100
},
{
"type": "null"
}
],
"title": "Code 1C"
},
"bank": {
"anyOf": [
{
"type": "string",
"maxLength": 64
},
{
"type": "null"
}
],
"title": "Bank"
},
"bik": {
"anyOf": [
{
"type": "string",
"maxLength": 11
},
{
"type": "null"
}
],
"title": "Bik"
},
"checking_account": {
"anyOf": [
{
"type": "string",
"maxLength": 32
},
{
"type": "null"
}
],
"title": "Checking Account"
},
"correspondent_account": {
"anyOf": [
{
"type": "string",
"maxLength": 32
},
{
"type": "null"
}
],
"title": "Correspondent Account"
},
"responsible": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/InsertByUUIDModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Responsible"
},
"subsidiary": {
"anyOf": [
{
"$ref": "#/components/schemas/InsertByOIDModel"
},
{
"type": "null"
}
]
},
"note": {
"anyOf": [
{
"type": "string",
"maxLength": 8192
},
{
"type": "null"
}
],
"title": "Note"
},
"etag": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Etag"
}
},
"type": "object",
"title": "ClientUpdateModel"
}
Response 200 OK
{
"id": "string",
"name": null,
"short_name": null,
"inn": null,
"kpp": null,
"ogrn": null,
"legal_address": null,
"actual_address": null,
"phone": null,
"email": null,
"website": null,
"code_1c": null,
"bank": null,
"bik": null,
"checking_account": null,
"correspondent_account": null,
"responsible": null,
"subsidiary": null,
"note": null,
"etag": null,
"text_search": null
}
Schema of the response body
{
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"name": {
"anyOf": [
{
"type": "string",
"maxLength": 80
},
{
"type": "null"
}
],
"title": "Name"
},
"short_name": {
"anyOf": [
{
"type": "string",
"maxLength": 40
},
{
"type": "null"
}
],
"title": "Short Name"
},
"inn": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Inn"
},
"kpp": {
"anyOf": [
{
"type": "string",
"maxLength": 32
},
{
"type": "null"
}
],
"title": "Kpp"
},
"ogrn": {
"anyOf": [
{
"type": "string",
"maxLength": 32
},
{
"type": "null"
}
],
"title": "Ogrn"
},
"legal_address": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"title": "Legal Address"
},
"actual_address": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"title": "Actual Address"
},
"phone": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Phone"
},
"email": {
"anyOf": [
{
"type": "string",
"format": "email"
},
{
"type": "null"
}
],
"title": "Email"
},
"website": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Website"
},
"code_1c": {
"anyOf": [
{
"type": "string",
"maxLength": 100
},
{
"type": "null"
}
],
"title": "Code 1C"
},
"bank": {
"anyOf": [
{
"type": "string",
"maxLength": 64
},
{
"type": "null"
}
],
"title": "Bank"
},
"bik": {
"anyOf": [
{
"type": "string",
"maxLength": 11
},
{
"type": "null"
}
],
"title": "Bik"
},
"checking_account": {
"anyOf": [
{
"type": "string",
"maxLength": 32
},
{
"type": "null"
}
],
"title": "Checking Account"
},
"correspondent_account": {
"anyOf": [
{
"type": "string",
"maxLength": 32
},
{
"type": "null"
}
],
"title": "Correspondent Account"
},
"responsible": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/SotransUserDBModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Responsible"
},
"subsidiary": {
"anyOf": [
{
"$ref": "#/components/schemas/SubsidiaryDBModel"
},
{
"type": "null"
}
]
},
"note": {
"anyOf": [
{
"type": "string",
"maxLength": 8192
},
{
"type": "null"
}
],
"title": "Note"
},
"etag": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Etag"
},
"text_search": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Text Search"
}
},
"type": "object",
"title": "ClientDBModel"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
DELETE /clients/{client_id}
Remove Client
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
client_id |
path | string | No |
Request body
Schema of the request body
{
"anyOf": [
{
"$ref": "#/components/schemas/ClientUpdateModel"
},
{
"type": "null"
}
],
"title": "Resource With Etag"
}
Response 204 No Content
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /clients/{client_id}
Clients Details
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
client_id |
path | string | No | ||
projection |
query | string | No |
Response 200 OK
{
"id": "string",
"name": null,
"short_name": null,
"inn": null,
"kpp": null,
"ogrn": null,
"legal_address": null,
"actual_address": null,
"phone": null,
"email": null,
"website": null,
"code_1c": null,
"bank": null,
"bik": null,
"checking_account": null,
"correspondent_account": null,
"responsible": null,
"subsidiary": null,
"note": null,
"etag": null,
"text_search": null
}
Schema of the response body
{
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"name": {
"anyOf": [
{
"type": "string",
"maxLength": 80
},
{
"type": "null"
}
],
"title": "Name"
},
"short_name": {
"anyOf": [
{
"type": "string",
"maxLength": 40
},
{
"type": "null"
}
],
"title": "Short Name"
},
"inn": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Inn"
},
"kpp": {
"anyOf": [
{
"type": "string",
"maxLength": 32
},
{
"type": "null"
}
],
"title": "Kpp"
},
"ogrn": {
"anyOf": [
{
"type": "string",
"maxLength": 32
},
{
"type": "null"
}
],
"title": "Ogrn"
},
"legal_address": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"title": "Legal Address"
},
"actual_address": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"title": "Actual Address"
},
"phone": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Phone"
},
"email": {
"anyOf": [
{
"type": "string",
"format": "email"
},
{
"type": "null"
}
],
"title": "Email"
},
"website": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Website"
},
"code_1c": {
"anyOf": [
{
"type": "string",
"maxLength": 100
},
{
"type": "null"
}
],
"title": "Code 1C"
},
"bank": {
"anyOf": [
{
"type": "string",
"maxLength": 64
},
{
"type": "null"
}
],
"title": "Bank"
},
"bik": {
"anyOf": [
{
"type": "string",
"maxLength": 11
},
{
"type": "null"
}
],
"title": "Bik"
},
"checking_account": {
"anyOf": [
{
"type": "string",
"maxLength": 32
},
{
"type": "null"
}
],
"title": "Checking Account"
},
"correspondent_account": {
"anyOf": [
{
"type": "string",
"maxLength": 32
},
{
"type": "null"
}
],
"title": "Correspondent Account"
},
"responsible": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/SotransUserDBModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Responsible"
},
"subsidiary": {
"anyOf": [
{
"$ref": "#/components/schemas/SubsidiaryDBModel"
},
{
"type": "null"
}
]
},
"note": {
"anyOf": [
{
"type": "string",
"maxLength": 8192
},
{
"type": "null"
}
],
"title": "Note"
},
"etag": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Etag"
},
"text_search": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Text Search"
}
},
"type": "object",
"title": "ClientDBModel"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 404 Not Found
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
managers_clients_assignment
PUT /clients/{client_id}/assign
Assign To Client
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
client_id |
path | string | No |
Request body
Schema of the request body
{
"anyOf": [
{
"$ref": "#/components/schemas/InsertByOIDModel"
},
{
"$ref": "#/components/schemas/InsertByUUIDModel"
}
],
"title": "Assignee"
}
Response 201 Created
Schema of the response body
{
"anyOf": [
{
"$ref": "#/components/schemas/GenericGetListResponse_SotransUserDBModel_"
},
{
"$ref": "#/components/schemas/AssignedToClientResponse"
}
],
"title": "Response Assign To Client Clients Client Id Assign Put"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /clients/{client_id}/assign
Get Clients Assigned
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
client_id |
path | string | No |
Response 200 OK
{
"items": [
{
"email": null,
"name": null,
"surname": null,
"patronymic": null,
"phone": null,
"job_title": null,
"status": null,
"photo": null,
"subsidiary_id": null,
"organization_id": null,
"policy": null,
"note": null,
"username": null,
"id": "string",
"roles": [
"string"
],
"role": "string",
"text_search": null,
"subsidiary_name": null,
"password": null
}
],
"total": 0
}
Schema of the response body
{
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/SotransUserDBModel"
},
"type": "array",
"title": "Items"
},
"total": {
"type": "integer",
"title": "Total"
}
},
"type": "object",
"required": [
"items",
"total"
],
"title": "GenericGetListResponse[SotransUserDBModel]"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
DELETE /clients/{client_id}/revoke
Revoke From Client
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
client_id |
path | string | No |
Request body
Schema of the request body
{
"anyOf": [
{
"$ref": "#/components/schemas/InsertByOIDModel"
},
{
"$ref": "#/components/schemas/InsertByUUIDModel"
}
],
"title": "Assignee"
}
Response 204 No Content
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
buffer
PUT /buffer-orders/{order_ids}/to-appointment
Assign Order
Description
Accepts assigned(req) and end_price.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
order_ids |
path | string | No |
Request body
{
"auction_end_time": null,
"stops": null,
"peculiarities": null,
"cargo_type": null,
"truck_body": null,
"client_price": null,
"start_price": null,
"end_price": null,
"currency": null,
"currency_caption": null,
"vat_type": null,
"rate_step": null,
"status": null,
"note": null,
"external": null,
"client": null,
"assigned": null,
"carrier": null,
"driver": null,
"truck": null,
"trailer": null,
"documents": null,
"cancel_reason": null,
"etag": null
}
Schema of the request body
{
"properties": {
"auction_end_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Auction End Time"
},
"stops": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/StopModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Stops"
},
"peculiarities": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"title": "Peculiarities"
},
"cargo_type": {
"anyOf": [
{
"type": "string",
"maxLength": 2048
},
{
"type": "null"
}
],
"title": "Cargo Type"
},
"truck_body": {
"anyOf": [
{
"$ref": "#/components/schemas/BodySettingsModel"
},
{
"type": "null"
}
]
},
"client_price": {
"anyOf": [
{
"type": "integer",
"minimum": 0.0
},
{
"type": "null"
}
],
"title": "Client Price"
},
"start_price": {
"anyOf": [
{
"type": "integer",
"exclusiveMaximum": 100000000.0,
"exclusiveMinimum": 0.0
},
{
"type": "null"
}
],
"title": "Start Price"
},
"end_price": {
"anyOf": [
{
"type": "integer",
"exclusiveMaximum": 100000000.0,
"exclusiveMinimum": 0.0
},
{
"type": "null"
}
],
"title": "End Price"
},
"currency": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency"
},
"currency_caption": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency Caption"
},
"vat_type": {
"anyOf": [
{
"$ref": "#/components/schemas/VATType"
},
{
"type": "null"
}
]
},
"rate_step": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Rate Step"
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderStatus"
},
{
"type": "null"
}
]
},
"note": {
"anyOf": [
{
"type": "string",
"maxLength": 8192
},
{
"type": "null"
}
],
"title": "Note"
},
"external": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderExternalData"
},
{
"type": "null"
}
]
},
"client": {
"anyOf": [
{
"$ref": "#/components/schemas/ClientCreateModel"
},
{
"$ref": "#/components/schemas/InsertByOIDModel"
},
{
"type": "null"
}
],
"title": "Client"
},
"assigned": {
"anyOf": [
{
"$ref": "#/components/schemas/AssignedCreateModel"
},
{
"type": "null"
}
]
},
"carrier": {
"anyOf": [
{
"$ref": "#/components/schemas/InsertByOIDModel"
},
{
"type": "null"
}
]
},
"driver": {
"anyOf": [
{
"$ref": "#/components/schemas/InsertByOIDModel"
},
{
"type": "null"
}
]
},
"truck": {
"anyOf": [
{
"$ref": "#/components/schemas/InsertByOIDModel"
},
{
"type": "null"
}
]
},
"trailer": {
"anyOf": [
{
"$ref": "#/components/schemas/InsertByOIDModel"
},
{
"type": "null"
}
]
},
"documents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/InsertByOIDModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Documents"
},
"cancel_reason": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"title": "Cancel Reason"
},
"etag": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Etag"
}
},
"type": "object",
"title": "OrderUpdateModel"
}
Response 200 OK
{
"raised_ids": {}
}
Schema of the response body
{
"properties": {
"raised_ids": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Raised Ids"
}
},
"type": "object",
"required": [
"raised_ids"
],
"title": "MultiselectError"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
PUT /buffer-orders/{order_ids}/to-exchange
Put Order To Exchange
Description
Accepts start_price(req), auction_end_time(must be in result) and assigned.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
order_ids |
path | string | No |
Request body
{
"auction_end_time": null,
"stops": null,
"peculiarities": null,
"cargo_type": null,
"truck_body": null,
"client_price": null,
"start_price": null,
"end_price": null,
"currency": null,
"currency_caption": null,
"vat_type": null,
"rate_step": null,
"status": null,
"note": null,
"external": null,
"client": null,
"assigned": null,
"carrier": null,
"driver": null,
"truck": null,
"trailer": null,
"documents": null,
"cancel_reason": null,
"etag": null
}
Schema of the request body
{
"properties": {
"auction_end_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Auction End Time"
},
"stops": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/StopModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Stops"
},
"peculiarities": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"title": "Peculiarities"
},
"cargo_type": {
"anyOf": [
{
"type": "string",
"maxLength": 2048
},
{
"type": "null"
}
],
"title": "Cargo Type"
},
"truck_body": {
"anyOf": [
{
"$ref": "#/components/schemas/BodySettingsModel"
},
{
"type": "null"
}
]
},
"client_price": {
"anyOf": [
{
"type": "integer",
"minimum": 0.0
},
{
"type": "null"
}
],
"title": "Client Price"
},
"start_price": {
"anyOf": [
{
"type": "integer",
"exclusiveMaximum": 100000000.0,
"exclusiveMinimum": 0.0
},
{
"type": "null"
}
],
"title": "Start Price"
},
"end_price": {
"anyOf": [
{
"type": "integer",
"exclusiveMaximum": 100000000.0,
"exclusiveMinimum": 0.0
},
{
"type": "null"
}
],
"title": "End Price"
},
"currency": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency"
},
"currency_caption": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency Caption"
},
"vat_type": {
"anyOf": [
{
"$ref": "#/components/schemas/VATType"
},
{
"type": "null"
}
]
},
"rate_step": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Rate Step"
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderStatus"
},
{
"type": "null"
}
]
},
"note": {
"anyOf": [
{
"type": "string",
"maxLength": 8192
},
{
"type": "null"
}
],
"title": "Note"
},
"external": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderExternalData"
},
{
"type": "null"
}
]
},
"client": {
"anyOf": [
{
"$ref": "#/components/schemas/ClientCreateModel"
},
{
"$ref": "#/components/schemas/InsertByOIDModel"
},
{
"type": "null"
}
],
"title": "Client"
},
"assigned": {
"anyOf": [
{
"$ref": "#/components/schemas/AssignedCreateModel"
},
{
"type": "null"
}
]
},
"carrier": {
"anyOf": [
{
"$ref": "#/components/schemas/InsertByOIDModel"
},
{
"type": "null"
}
]
},
"driver": {
"anyOf": [
{
"$ref": "#/components/schemas/InsertByOIDModel"
},
{
"type": "null"
}
]
},
"truck": {
"anyOf": [
{
"$ref": "#/components/schemas/InsertByOIDModel"
},
{
"type": "null"
}
]
},
"trailer": {
"anyOf": [
{
"$ref": "#/components/schemas/InsertByOIDModel"
},
{
"type": "null"
}
]
},
"documents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/InsertByOIDModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Documents"
},
"cancel_reason": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"title": "Cancel Reason"
},
"etag": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Etag"
}
},
"type": "object",
"title": "OrderUpdateModel"
}
Response 200 OK
{
"raised_ids": {}
}
Schema of the response body
{
"properties": {
"raised_ids": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Raised Ids"
}
},
"type": "object",
"required": [
"raised_ids"
],
"title": "MultiselectError"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /buffer-orders
Get Buffer Orders
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
assignment |
query | string | No | ||
limit |
query | integer | 200 | No | |
projection |
query | string | No | ||
search |
query | string | No | ||
skip |
query | integer | 0 | No | |
sort |
query | string | No | ||
where |
query | string | No |
Response 200 OK
{
"items": [
{
"id": "string",
"auction_end_time": null,
"stops": null,
"peculiarities": null,
"cargo_type": null,
"truck_body": null,
"client_price": null,
"start_price": null,
"end_price": null,
"currency": null,
"currency_caption": null,
"vat_type": null,
"rate_step": null,
"status": null,
"note": null,
"external": null,
"client": null,
"assigned": null,
"carrier": null,
"driver": null,
"truck": null,
"trailer": null,
"documents": null,
"cancel_reason": null,
"etag": null,
"completed_stages": null,
"created_at": null,
"your_bid": null,
"best_bid": null,
"confirmation_end_time": null,
"reservation_end_time": null,
"short_id": null,
"deleted_at": null,
"current_stage": null,
"document_draft": null,
"start_price_km": null,
"end_price_km": null,
"route_km": null,
"text_search": null,
"updated": null
}
],
"total": 0
}
Schema of the response body
{
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/OrderDBModel"
},
"type": "array",
"title": "Items"
},
"total": {
"type": "integer",
"title": "Total"
}
},
"type": "object",
"required": [
"items",
"total"
],
"title": "GenericGetListResponse[OrderDBModel]"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
POST /buffer-orders
Insert Into Buffer
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No |
Request body
{
"auction_end_time": null,
"stops": [
{
"index": null,
"datetime": null,
"address": null,
"stop_type": null,
"note": null
}
],
"peculiarities": null,
"cargo_type": null,
"truck_body": {
"body_type": null,
"loading_type": null,
"weight": null,
"volume": null
},
"client_price": 0,
"start_price": null,
"end_price": null,
"currency": "string",
"currency_caption": "string",
"vat_type": null,
"rate_step": 0,
"status": null,
"note": null,
"external": null,
"client": null,
"assigned": null,
"carrier": null,
"driver": null,
"truck": null,
"trailer": null,
"documents": null
}
Schema of the request body
{
"properties": {
"auction_end_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Auction End Time"
},
"stops": {
"items": {
"$ref": "#/components/schemas/StopModel"
},
"type": "array",
"title": "Stops"
},
"peculiarities": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"title": "Peculiarities"
},
"cargo_type": {
"anyOf": [
{
"type": "string",
"maxLength": 2048
},
{
"type": "null"
}
],
"title": "Cargo Type"
},
"truck_body": {
"$ref": "#/components/schemas/BodySettingsModel"
},
"client_price": {
"type": "integer",
"minimum": 0.0,
"title": "Client Price"
},
"start_price": {
"anyOf": [
{
"type": "integer",
"exclusiveMaximum": 100000000.0,
"exclusiveMinimum": 0.0
},
{
"type": "null"
}
],
"title": "Start Price"
},
"end_price": {
"anyOf": [
{
"type": "integer",
"exclusiveMaximum": 100000000.0,
"exclusiveMinimum": 0.0
},
{
"type": "null"
}
],
"title": "End Price"
},
"currency": {
"type": "string",
"title": "Currency",
"default": "RUB"
},
"currency_caption": {
"type": "string",
"title": "Currency Caption",
"default": "руб."
},
"vat_type": {
"allOf": [
{
"$ref": "#/components/schemas/VATType"
}
],
"default": "nds_included"
},
"rate_step": {
"type": "integer",
"title": "Rate Step",
"default": 1000
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/OrderStatus"
}
],
"default": "buffer"
},
"note": {
"anyOf": [
{
"type": "string",
"maxLength": 8192
},
{
"type": "null"
}
],
"title": "Note"
},
"external": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderExternalData"
},
{
"type": "null"
}
]
},
"client": {
"anyOf": [
{
"$ref": "#/components/schemas/ClientCreateModel"
},
{
"$ref": "#/components/schemas/InsertByOIDModel"
}
],
"title": "Client"
},
"assigned": {
"anyOf": [
{
"$ref": "#/components/schemas/AssignedCreateModel"
},
{
"type": "null"
}
]
},
"carrier": {
"anyOf": [
{
"$ref": "#/components/schemas/InsertByOIDModel"
},
{
"type": "null"
}
]
},
"driver": {
"anyOf": [
{
"$ref": "#/components/schemas/InsertByOIDModel"
},
{
"type": "null"
}
]
},
"truck": {
"anyOf": [
{
"$ref": "#/components/schemas/InsertByOIDModel"
},
{
"type": "null"
}
]
},
"trailer": {
"anyOf": [
{
"$ref": "#/components/schemas/InsertByOIDModel"
},
{
"type": "null"
}
]
},
"documents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/InsertByOIDModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Documents"
}
},
"type": "object",
"required": [
"stops",
"truck_body",
"client_price",
"client"
],
"title": "OrderCreateModel"
}
Response 201 Created
{
"id": "string",
"auction_end_time": null,
"stops": null,
"peculiarities": null,
"cargo_type": null,
"truck_body": null,
"client_price": null,
"start_price": null,
"end_price": null,
"currency": null,
"currency_caption": null,
"vat_type": null,
"rate_step": null,
"status": null,
"note": null,
"external": null,
"client": null,
"assigned": null,
"carrier": null,
"driver": null,
"truck": null,
"trailer": null,
"documents": null,
"cancel_reason": null,
"etag": null,
"completed_stages": null,
"created_at": null,
"your_bid": null,
"best_bid": null,
"confirmation_end_time": null,
"reservation_end_time": null,
"short_id": null,
"deleted_at": null,
"current_stage": null,
"document_draft": null,
"start_price_km": null,
"end_price_km": null,
"route_km": null,
"text_search": null,
"updated": null
}
Schema of the response body
{
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"auction_end_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Auction End Time"
},
"stops": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/StopModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Stops"
},
"peculiarities": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"title": "Peculiarities"
},
"cargo_type": {
"anyOf": [
{
"type": "string",
"maxLength": 2048
},
{
"type": "null"
}
],
"title": "Cargo Type"
},
"truck_body": {
"anyOf": [
{
"$ref": "#/components/schemas/BodySettingsModel"
},
{
"type": "null"
}
]
},
"client_price": {
"anyOf": [
{
"type": "integer",
"minimum": 0.0
},
{
"type": "null"
}
],
"title": "Client Price"
},
"start_price": {
"anyOf": [
{
"type": "integer",
"exclusiveMaximum": 100000000.0,
"exclusiveMinimum": 0.0
},
{
"type": "null"
}
],
"title": "Start Price"
},
"end_price": {
"anyOf": [
{
"type": "integer",
"exclusiveMaximum": 100000000.0,
"exclusiveMinimum": 0.0
},
{
"type": "null"
}
],
"title": "End Price"
},
"currency": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency"
},
"currency_caption": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency Caption"
},
"vat_type": {
"anyOf": [
{
"$ref": "#/components/schemas/VATType"
},
{
"type": "null"
}
]
},
"rate_step": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Rate Step"
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderStatus"
},
{
"type": "null"
}
]
},
"note": {
"anyOf": [
{
"type": "string",
"maxLength": 8192
},
{
"type": "null"
}
],
"title": "Note"
},
"external": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderExternalData"
},
{
"type": "null"
}
]
},
"client": {
"anyOf": [
{
"$ref": "#/components/schemas/ClientDBModel"
},
{
"type": "null"
}
]
},
"assigned": {
"anyOf": [
{
"$ref": "#/components/schemas/AssignedModel"
},
{
"type": "null"
}
]
},
"carrier": {
"anyOf": [
{
"$ref": "#/components/schemas/OrganizationDBModel"
},
{
"type": "null"
}
]
},
"driver": {
"anyOf": [
{
"$ref": "#/components/schemas/DriverDBModel"
},
{
"type": "null"
}
]
},
"truck": {
"anyOf": [
{
"$ref": "#/components/schemas/TruckDBModel"
},
{
"type": "null"
}
]
},
"trailer": {
"anyOf": [
{
"$ref": "#/components/schemas/TrailerDBModel"
},
{
"type": "null"
}
]
},
"documents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/DocumentDBModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Documents"
},
"cancel_reason": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"title": "Cancel Reason"
},
"etag": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Etag"
},
"completed_stages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/OrderStageModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Completed Stages"
},
"created_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At"
},
"your_bid": {
"anyOf": [
{
"$ref": "#/components/schemas/BidDBModel"
},
{
"type": "null"
}
]
},
"best_bid": {
"anyOf": [
{
"$ref": "#/components/schemas/BidDBModel"
},
{
"type": "null"
}
]
},
"confirmation_end_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Confirmation End Time"
},
"reservation_end_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Reservation End Time"
},
"short_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Short Id"
},
"deleted_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Deleted At"
},
"current_stage": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderStageModel"
},
{
"type": "null"
}
]
},
"document_draft": {
"anyOf": [
{
"$ref": "#/components/schemas/DocumentDBModel"
},
{
"type": "null"
}
]
},
"start_price_km": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Start Price Km"
},
"end_price_km": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "End Price Km"
},
"route_km": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Route Km"
},
"text_search": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Text Search"
},
"updated": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/UpdateMetadata"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Updated"
}
},
"type": "object",
"title": "OrderDBModel"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 400 Bad Request
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /buffer-orders/xlsx
Excel Export Buffer
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
assignment |
query | string | No | ||
limit |
query | integer | 200 | No | |
projection |
query | string | No | ||
search |
query | string | No | ||
skip |
query | integer | 0 | No | |
sort |
query | string | No | ||
where |
query | string | No |
Response 200 OK
Schema of the response body
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
POST /buffer-orders/xlsx
Import To Buffer
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No |
Request body
{
"xls_file": "TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ="
}
Schema of the request body
{
"properties": {
"xls_file": {
"type": "string",
"format": "binary",
"title": "Xls File"
}
},
"type": "object",
"required": [
"xls_file"
],
"title": "Body_import_to_buffer_buffer_orders_xlsx_post"
}
Response 200 OK
{
"items": [
{
"id": "string",
"auction_end_time": null,
"stops": null,
"peculiarities": null,
"cargo_type": null,
"truck_body": null,
"client_price": null,
"start_price": null,
"end_price": null,
"currency": null,
"currency_caption": null,
"vat_type": null,
"rate_step": null,
"status": null,
"note": null,
"external": null,
"client": null,
"assigned": null,
"carrier": null,
"driver": null,
"truck": null,
"trailer": null,
"documents": null,
"cancel_reason": null,
"etag": null,
"completed_stages": null,
"created_at": null,
"your_bid": null,
"best_bid": null,
"confirmation_end_time": null,
"reservation_end_time": null,
"short_id": null,
"deleted_at": null,
"current_stage": null,
"document_draft": null,
"start_price_km": null,
"end_price_km": null,
"route_km": null,
"text_search": null,
"updated": null
}
],
"total": 0
}
Schema of the response body
{
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/OrderDBModel"
},
"type": "array",
"title": "Items"
},
"total": {
"type": "integer",
"title": "Total"
}
},
"type": "object",
"required": [
"items",
"total"
],
"title": "GenericGetListResponse[OrderDBModel]"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /buffer-orders/{order_id}
Buffer Details
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
order_id |
path | string | No | ||
projection |
query | string | No |
Response 200 OK
{
"id": "string",
"auction_end_time": null,
"stops": null,
"peculiarities": null,
"cargo_type": null,
"truck_body": null,
"client_price": null,
"start_price": null,
"end_price": null,
"currency": null,
"currency_caption": null,
"vat_type": null,
"rate_step": null,
"status": null,
"note": null,
"external": null,
"client": null,
"assigned": null,
"carrier": null,
"driver": null,
"truck": null,
"trailer": null,
"documents": null,
"cancel_reason": null,
"etag": null,
"completed_stages": null,
"created_at": null,
"your_bid": null,
"best_bid": null,
"confirmation_end_time": null,
"reservation_end_time": null,
"short_id": null,
"deleted_at": null,
"current_stage": null,
"document_draft": null,
"start_price_km": null,
"end_price_km": null,
"route_km": null,
"text_search": null,
"updated": null
}
Schema of the response body
{
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"auction_end_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Auction End Time"
},
"stops": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/StopModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Stops"
},
"peculiarities": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"title": "Peculiarities"
},
"cargo_type": {
"anyOf": [
{
"type": "string",
"maxLength": 2048
},
{
"type": "null"
}
],
"title": "Cargo Type"
},
"truck_body": {
"anyOf": [
{
"$ref": "#/components/schemas/BodySettingsModel"
},
{
"type": "null"
}
]
},
"client_price": {
"anyOf": [
{
"type": "integer",
"minimum": 0.0
},
{
"type": "null"
}
],
"title": "Client Price"
},
"start_price": {
"anyOf": [
{
"type": "integer",
"exclusiveMaximum": 100000000.0,
"exclusiveMinimum": 0.0
},
{
"type": "null"
}
],
"title": "Start Price"
},
"end_price": {
"anyOf": [
{
"type": "integer",
"exclusiveMaximum": 100000000.0,
"exclusiveMinimum": 0.0
},
{
"type": "null"
}
],
"title": "End Price"
},
"currency": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency"
},
"currency_caption": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency Caption"
},
"vat_type": {
"anyOf": [
{
"$ref": "#/components/schemas/VATType"
},
{
"type": "null"
}
]
},
"rate_step": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Rate Step"
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderStatus"
},
{
"type": "null"
}
]
},
"note": {
"anyOf": [
{
"type": "string",
"maxLength": 8192
},
{
"type": "null"
}
],
"title": "Note"
},
"external": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderExternalData"
},
{
"type": "null"
}
]
},
"client": {
"anyOf": [
{
"$ref": "#/components/schemas/ClientDBModel"
},
{
"type": "null"
}
]
},
"assigned": {
"anyOf": [
{
"$ref": "#/components/schemas/AssignedModel"
},
{
"type": "null"
}
]
},
"carrier": {
"anyOf": [
{
"$ref": "#/components/schemas/OrganizationDBModel"
},
{
"type": "null"
}
]
},
"driver": {
"anyOf": [
{
"$ref": "#/components/schemas/DriverDBModel"
},
{
"type": "null"
}
]
},
"truck": {
"anyOf": [
{
"$ref": "#/components/schemas/TruckDBModel"
},
{
"type": "null"
}
]
},
"trailer": {
"anyOf": [
{
"$ref": "#/components/schemas/TrailerDBModel"
},
{
"type": "null"
}
]
},
"documents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/DocumentDBModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Documents"
},
"cancel_reason": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"title": "Cancel Reason"
},
"etag": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Etag"
},
"completed_stages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/OrderStageModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Completed Stages"
},
"created_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At"
},
"your_bid": {
"anyOf": [
{
"$ref": "#/components/schemas/BidDBModel"
},
{
"type": "null"
}
]
},
"best_bid": {
"anyOf": [
{
"$ref": "#/components/schemas/BidDBModel"
},
{
"type": "null"
}
]
},
"confirmation_end_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Confirmation End Time"
},
"reservation_end_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Reservation End Time"
},
"short_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Short Id"
},
"deleted_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Deleted At"
},
"current_stage": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderStageModel"
},
{
"type": "null"
}
]
},
"document_draft": {
"anyOf": [
{
"$ref": "#/components/schemas/DocumentDBModel"
},
{
"type": "null"
}
]
},
"start_price_km": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Start Price Km"
},
"end_price_km": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "End Price Km"
},
"route_km": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Route Km"
},
"text_search": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Text Search"
},
"updated": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/UpdateMetadata"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Updated"
}
},
"type": "object",
"title": "OrderDBModel"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 404 Not Found
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
PATCH /buffer-orders/{order_id}
Update Order Data
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
order_id |
path | string | No |
Request body
{
"auction_end_time": null,
"stops": null,
"peculiarities": null,
"cargo_type": null,
"truck_body": null,
"client_price": null,
"start_price": null,
"end_price": null,
"currency": null,
"currency_caption": null,
"vat_type": null,
"rate_step": null,
"status": null,
"note": null,
"external": null,
"client": null,
"assigned": null,
"carrier": null,
"driver": null,
"truck": null,
"trailer": null,
"documents": null,
"cancel_reason": null,
"etag": null
}
Schema of the request body
{
"properties": {
"auction_end_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Auction End Time"
},
"stops": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/StopModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Stops"
},
"peculiarities": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"title": "Peculiarities"
},
"cargo_type": {
"anyOf": [
{
"type": "string",
"maxLength": 2048
},
{
"type": "null"
}
],
"title": "Cargo Type"
},
"truck_body": {
"anyOf": [
{
"$ref": "#/components/schemas/BodySettingsModel"
},
{
"type": "null"
}
]
},
"client_price": {
"anyOf": [
{
"type": "integer",
"minimum": 0.0
},
{
"type": "null"
}
],
"title": "Client Price"
},
"start_price": {
"anyOf": [
{
"type": "integer",
"exclusiveMaximum": 100000000.0,
"exclusiveMinimum": 0.0
},
{
"type": "null"
}
],
"title": "Start Price"
},
"end_price": {
"anyOf": [
{
"type": "integer",
"exclusiveMaximum": 100000000.0,
"exclusiveMinimum": 0.0
},
{
"type": "null"
}
],
"title": "End Price"
},
"currency": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency"
},
"currency_caption": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency Caption"
},
"vat_type": {
"anyOf": [
{
"$ref": "#/components/schemas/VATType"
},
{
"type": "null"
}
]
},
"rate_step": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Rate Step"
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderStatus"
},
{
"type": "null"
}
]
},
"note": {
"anyOf": [
{
"type": "string",
"maxLength": 8192
},
{
"type": "null"
}
],
"title": "Note"
},
"external": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderExternalData"
},
{
"type": "null"
}
]
},
"client": {
"anyOf": [
{
"$ref": "#/components/schemas/ClientCreateModel"
},
{
"$ref": "#/components/schemas/InsertByOIDModel"
},
{
"type": "null"
}
],
"title": "Client"
},
"assigned": {
"anyOf": [
{
"$ref": "#/components/schemas/AssignedCreateModel"
},
{
"type": "null"
}
]
},
"carrier": {
"anyOf": [
{
"$ref": "#/components/schemas/InsertByOIDModel"
},
{
"type": "null"
}
]
},
"driver": {
"anyOf": [
{
"$ref": "#/components/schemas/InsertByOIDModel"
},
{
"type": "null"
}
]
},
"truck": {
"anyOf": [
{
"$ref": "#/components/schemas/InsertByOIDModel"
},
{
"type": "null"
}
]
},
"trailer": {
"anyOf": [
{
"$ref": "#/components/schemas/InsertByOIDModel"
},
{
"type": "null"
}
]
},
"documents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/InsertByOIDModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Documents"
},
"cancel_reason": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"title": "Cancel Reason"
},
"etag": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Etag"
}
},
"type": "object",
"title": "OrderUpdateModel"
}
Response 200 OK
{
"id": "string",
"auction_end_time": null,
"stops": null,
"peculiarities": null,
"cargo_type": null,
"truck_body": null,
"client_price": null,
"start_price": null,
"end_price": null,
"currency": null,
"currency_caption": null,
"vat_type": null,
"rate_step": null,
"status": null,
"note": null,
"external": null,
"client": null,
"assigned": null,
"carrier": null,
"driver": null,
"truck": null,
"trailer": null,
"documents": null,
"cancel_reason": null,
"etag": null,
"completed_stages": null,
"created_at": null,
"your_bid": null,
"best_bid": null,
"confirmation_end_time": null,
"reservation_end_time": null,
"short_id": null,
"deleted_at": null,
"current_stage": null,
"document_draft": null,
"start_price_km": null,
"end_price_km": null,
"route_km": null,
"text_search": null,
"updated": null
}
Schema of the response body
{
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"auction_end_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Auction End Time"
},
"stops": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/StopModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Stops"
},
"peculiarities": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"title": "Peculiarities"
},
"cargo_type": {
"anyOf": [
{
"type": "string",
"maxLength": 2048
},
{
"type": "null"
}
],
"title": "Cargo Type"
},
"truck_body": {
"anyOf": [
{
"$ref": "#/components/schemas/BodySettingsModel"
},
{
"type": "null"
}
]
},
"client_price": {
"anyOf": [
{
"type": "integer",
"minimum": 0.0
},
{
"type": "null"
}
],
"title": "Client Price"
},
"start_price": {
"anyOf": [
{
"type": "integer",
"exclusiveMaximum": 100000000.0,
"exclusiveMinimum": 0.0
},
{
"type": "null"
}
],
"title": "Start Price"
},
"end_price": {
"anyOf": [
{
"type": "integer",
"exclusiveMaximum": 100000000.0,
"exclusiveMinimum": 0.0
},
{
"type": "null"
}
],
"title": "End Price"
},
"currency": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency"
},
"currency_caption": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency Caption"
},
"vat_type": {
"anyOf": [
{
"$ref": "#/components/schemas/VATType"
},
{
"type": "null"
}
]
},
"rate_step": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Rate Step"
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderStatus"
},
{
"type": "null"
}
]
},
"note": {
"anyOf": [
{
"type": "string",
"maxLength": 8192
},
{
"type": "null"
}
],
"title": "Note"
},
"external": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderExternalData"
},
{
"type": "null"
}
]
},
"client": {
"anyOf": [
{
"$ref": "#/components/schemas/ClientDBModel"
},
{
"type": "null"
}
]
},
"assigned": {
"anyOf": [
{
"$ref": "#/components/schemas/AssignedModel"
},
{
"type": "null"
}
]
},
"carrier": {
"anyOf": [
{
"$ref": "#/components/schemas/OrganizationDBModel"
},
{
"type": "null"
}
]
},
"driver": {
"anyOf": [
{
"$ref": "#/components/schemas/DriverDBModel"
},
{
"type": "null"
}
]
},
"truck": {
"anyOf": [
{
"$ref": "#/components/schemas/TruckDBModel"
},
{
"type": "null"
}
]
},
"trailer": {
"anyOf": [
{
"$ref": "#/components/schemas/TrailerDBModel"
},
{
"type": "null"
}
]
},
"documents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/DocumentDBModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Documents"
},
"cancel_reason": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"title": "Cancel Reason"
},
"etag": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Etag"
},
"completed_stages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/OrderStageModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Completed Stages"
},
"created_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At"
},
"your_bid": {
"anyOf": [
{
"$ref": "#/components/schemas/BidDBModel"
},
{
"type": "null"
}
]
},
"best_bid": {
"anyOf": [
{
"$ref": "#/components/schemas/BidDBModel"
},
{
"type": "null"
}
]
},
"confirmation_end_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Confirmation End Time"
},
"reservation_end_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Reservation End Time"
},
"short_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Short Id"
},
"deleted_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Deleted At"
},
"current_stage": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderStageModel"
},
{
"type": "null"
}
]
},
"document_draft": {
"anyOf": [
{
"$ref": "#/components/schemas/DocumentDBModel"
},
{
"type": "null"
}
]
},
"start_price_km": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Start Price Km"
},
"end_price_km": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "End Price Km"
},
"route_km": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Route Km"
},
"text_search": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Text Search"
},
"updated": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/UpdateMetadata"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Updated"
}
},
"type": "object",
"title": "OrderDBModel"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 400 Bad Request
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
PUT /buffer-orders/{order_ids}/to-trash
Put Order To Trash
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
order_ids |
path | string | No |
Response 200 OK
{
"raised_ids": {}
}
Schema of the response body
{
"properties": {
"raised_ids": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Raised Ids"
}
},
"type": "object",
"required": [
"raised_ids"
],
"title": "MultiselectError"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 404 Not Found
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
orders
PUT /appointment-orders/{order_ids}/to-trash
Move Appointed To Trash
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
order_ids |
path | string | No |
Response 200 OK
{
"raised_ids": {}
}
Schema of the response body
{
"properties": {
"raised_ids": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Raised Ids"
}
},
"type": "object",
"required": [
"raised_ids"
],
"title": "MultiselectError"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 404 Not Found
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
PUT /appointment-orders/{order_ids}/to-buffer
Appointment To Buffer
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
order_ids |
path | string | No |
Request body
Schema of the request body
{
"anyOf": [
{
"$ref": "#/components/schemas/OrderUpdateModel"
},
{
"type": "null"
}
],
"title": "Order"
}
Response 200 OK
{
"raised_ids": {}
}
Schema of the response body
{
"properties": {
"raised_ids": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Raised Ids"
}
},
"type": "object",
"required": [
"raised_ids"
],
"title": "MultiselectError"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 404 Not Found
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
PUT /appointment-orders/{order_ids}/to-exchange
Appointment To Exchange
Description
Accepts start_price(required) and assigned. Must be finished with auction_end_time
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
order_ids |
path | string | No |
Request body
{
"auction_end_time": null,
"stops": null,
"peculiarities": null,
"cargo_type": null,
"truck_body": null,
"client_price": null,
"start_price": null,
"end_price": null,
"currency": null,
"currency_caption": null,
"vat_type": null,
"rate_step": null,
"status": null,
"note": null,
"external": null,
"client": null,
"assigned": null,
"carrier": null,
"driver": null,
"truck": null,
"trailer": null,
"documents": null,
"cancel_reason": null,
"etag": null
}
Schema of the request body
{
"properties": {
"auction_end_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Auction End Time"
},
"stops": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/StopModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Stops"
},
"peculiarities": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"title": "Peculiarities"
},
"cargo_type": {
"anyOf": [
{
"type": "string",
"maxLength": 2048
},
{
"type": "null"
}
],
"title": "Cargo Type"
},
"truck_body": {
"anyOf": [
{
"$ref": "#/components/schemas/BodySettingsModel"
},
{
"type": "null"
}
]
},
"client_price": {
"anyOf": [
{
"type": "integer",
"minimum": 0.0
},
{
"type": "null"
}
],
"title": "Client Price"
},
"start_price": {
"anyOf": [
{
"type": "integer",
"exclusiveMaximum": 100000000.0,
"exclusiveMinimum": 0.0
},
{
"type": "null"
}
],
"title": "Start Price"
},
"end_price": {
"anyOf": [
{
"type": "integer",
"exclusiveMaximum": 100000000.0,
"exclusiveMinimum": 0.0
},
{
"type": "null"
}
],
"title": "End Price"
},
"currency": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency"
},
"currency_caption": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency Caption"
},
"vat_type": {
"anyOf": [
{
"$ref": "#/components/schemas/VATType"
},
{
"type": "null"
}
]
},
"rate_step": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Rate Step"
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderStatus"
},
{
"type": "null"
}
]
},
"note": {
"anyOf": [
{
"type": "string",
"maxLength": 8192
},
{
"type": "null"
}
],
"title": "Note"
},
"external": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderExternalData"
},
{
"type": "null"
}
]
},
"client": {
"anyOf": [
{
"$ref": "#/components/schemas/ClientCreateModel"
},
{
"$ref": "#/components/schemas/InsertByOIDModel"
},
{
"type": "null"
}
],
"title": "Client"
},
"assigned": {
"anyOf": [
{
"$ref": "#/components/schemas/AssignedCreateModel"
},
{
"type": "null"
}
]
},
"carrier": {
"anyOf": [
{
"$ref": "#/components/schemas/InsertByOIDModel"
},
{
"type": "null"
}
]
},
"driver": {
"anyOf": [
{
"$ref": "#/components/schemas/InsertByOIDModel"
},
{
"type": "null"
}
]
},
"truck": {
"anyOf": [
{
"$ref": "#/components/schemas/InsertByOIDModel"
},
{
"type": "null"
}
]
},
"trailer": {
"anyOf": [
{
"$ref": "#/components/schemas/InsertByOIDModel"
},
{
"type": "null"
}
]
},
"documents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/InsertByOIDModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Documents"
},
"cancel_reason": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"title": "Cancel Reason"
},
"etag": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Etag"
}
},
"type": "object",
"title": "OrderUpdateModel"
}
Response 200 OK
{
"raised_ids": {}
}
Schema of the response body
{
"properties": {
"raised_ids": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Raised Ids"
}
},
"type": "object",
"required": [
"raised_ids"
],
"title": "MultiselectError"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /appointment-orders
Get Appointment
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
assignment |
query | string | No | ||
limit |
query | integer | 200 | No | |
projection |
query | string | No | ||
search |
query | string | No | ||
skip |
query | integer | 0 | No | |
sort |
query | string | No | ||
where |
query | string | No |
Response 200 OK
{
"items": [
{
"id": "string",
"auction_end_time": null,
"stops": null,
"peculiarities": null,
"cargo_type": null,
"truck_body": null,
"client_price": null,
"start_price": null,
"end_price": null,
"currency": null,
"currency_caption": null,
"vat_type": null,
"rate_step": null,
"status": null,
"note": null,
"external": null,
"client": null,
"assigned": null,
"carrier": null,
"driver": null,
"truck": null,
"trailer": null,
"documents": null,
"cancel_reason": null,
"etag": null,
"completed_stages": null,
"created_at": null,
"your_bid": null,
"best_bid": null,
"confirmation_end_time": null,
"reservation_end_time": null,
"short_id": null,
"deleted_at": null,
"current_stage": null,
"document_draft": null,
"start_price_km": null,
"end_price_km": null,
"route_km": null,
"text_search": null,
"updated": null
}
],
"total": 0
}
Schema of the response body
{
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/OrderDBModel"
},
"type": "array",
"title": "Items"
},
"total": {
"type": "integer",
"title": "Total"
}
},
"type": "object",
"required": [
"items",
"total"
],
"title": "GenericGetListResponse[OrderDBModel]"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /appointment-orders/{order_id}
Get Appointment By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
order_id |
path | string | No | ||
projection |
query | string | No |
Response 200 OK
{
"id": "string",
"auction_end_time": null,
"stops": null,
"peculiarities": null,
"cargo_type": null,
"truck_body": null,
"client_price": null,
"start_price": null,
"end_price": null,
"currency": null,
"currency_caption": null,
"vat_type": null,
"rate_step": null,
"status": null,
"note": null,
"external": null,
"client": null,
"assigned": null,
"carrier": null,
"driver": null,
"truck": null,
"trailer": null,
"documents": null,
"cancel_reason": null,
"etag": null,
"completed_stages": null,
"created_at": null,
"your_bid": null,
"best_bid": null,
"confirmation_end_time": null,
"reservation_end_time": null,
"short_id": null,
"deleted_at": null,
"current_stage": null,
"document_draft": null,
"start_price_km": null,
"end_price_km": null,
"route_km": null,
"text_search": null,
"updated": null
}
Schema of the response body
{
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"auction_end_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Auction End Time"
},
"stops": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/StopModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Stops"
},
"peculiarities": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"title": "Peculiarities"
},
"cargo_type": {
"anyOf": [
{
"type": "string",
"maxLength": 2048
},
{
"type": "null"
}
],
"title": "Cargo Type"
},
"truck_body": {
"anyOf": [
{
"$ref": "#/components/schemas/BodySettingsModel"
},
{
"type": "null"
}
]
},
"client_price": {
"anyOf": [
{
"type": "integer",
"minimum": 0.0
},
{
"type": "null"
}
],
"title": "Client Price"
},
"start_price": {
"anyOf": [
{
"type": "integer",
"exclusiveMaximum": 100000000.0,
"exclusiveMinimum": 0.0
},
{
"type": "null"
}
],
"title": "Start Price"
},
"end_price": {
"anyOf": [
{
"type": "integer",
"exclusiveMaximum": 100000000.0,
"exclusiveMinimum": 0.0
},
{
"type": "null"
}
],
"title": "End Price"
},
"currency": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency"
},
"currency_caption": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency Caption"
},
"vat_type": {
"anyOf": [
{
"$ref": "#/components/schemas/VATType"
},
{
"type": "null"
}
]
},
"rate_step": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Rate Step"
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderStatus"
},
{
"type": "null"
}
]
},
"note": {
"anyOf": [
{
"type": "string",
"maxLength": 8192
},
{
"type": "null"
}
],
"title": "Note"
},
"external": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderExternalData"
},
{
"type": "null"
}
]
},
"client": {
"anyOf": [
{
"$ref": "#/components/schemas/ClientDBModel"
},
{
"type": "null"
}
]
},
"assigned": {
"anyOf": [
{
"$ref": "#/components/schemas/AssignedModel"
},
{
"type": "null"
}
]
},
"carrier": {
"anyOf": [
{
"$ref": "#/components/schemas/OrganizationDBModel"
},
{
"type": "null"
}
]
},
"driver": {
"anyOf": [
{
"$ref": "#/components/schemas/DriverDBModel"
},
{
"type": "null"
}
]
},
"truck": {
"anyOf": [
{
"$ref": "#/components/schemas/TruckDBModel"
},
{
"type": "null"
}
]
},
"trailer": {
"anyOf": [
{
"$ref": "#/components/schemas/TrailerDBModel"
},
{
"type": "null"
}
]
},
"documents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/DocumentDBModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Documents"
},
"cancel_reason": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"title": "Cancel Reason"
},
"etag": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Etag"
},
"completed_stages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/OrderStageModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Completed Stages"
},
"created_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At"
},
"your_bid": {
"anyOf": [
{
"$ref": "#/components/schemas/BidDBModel"
},
{
"type": "null"
}
]
},
"best_bid": {
"anyOf": [
{
"$ref": "#/components/schemas/BidDBModel"
},
{
"type": "null"
}
]
},
"confirmation_end_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Confirmation End Time"
},
"reservation_end_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Reservation End Time"
},
"short_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Short Id"
},
"deleted_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Deleted At"
},
"current_stage": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderStageModel"
},
{
"type": "null"
}
]
},
"document_draft": {
"anyOf": [
{
"$ref": "#/components/schemas/DocumentDBModel"
},
{
"type": "null"
}
]
},
"start_price_km": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Start Price Km"
},
"end_price_km": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "End Price Km"
},
"route_km": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Route Km"
},
"text_search": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Text Search"
},
"updated": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/UpdateMetadata"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Updated"
}
},
"type": "object",
"title": "OrderDBModel"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 404 Not Found
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /active-orders/{order_id}/stages
Get Stages Suggestions
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
order_id |
path | string | No |
Response 200 OK
[
{
"id": 0,
"label": "string"
}
]
Schema of the response body
{
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderStageSuggestModel"
},
"title": "Response Get Stages Suggestions Active Orders Order Id Stages Get"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /active-orders
Get Active Orders
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
assignment |
query | string | No | ||
limit |
query | integer | 200 | No | |
projection |
query | string | No | ||
search |
query | string | No | ||
skip |
query | integer | 0 | No | |
sort |
query | string | No | ||
where |
query | string | No |
Response 200 OK
{
"items": [
{
"id": "string",
"auction_end_time": null,
"stops": null,
"peculiarities": null,
"cargo_type": null,
"truck_body": null,
"client_price": null,
"start_price": null,
"end_price": null,
"currency": null,
"currency_caption": null,
"vat_type": null,
"rate_step": null,
"status": null,
"note": null,
"external": null,
"client": null,
"assigned": null,
"carrier": null,
"driver": null,
"truck": null,
"trailer": null,
"documents": null,
"cancel_reason": null,
"etag": null,
"completed_stages": null,
"created_at": null,
"your_bid": null,
"best_bid": null,
"confirmation_end_time": null,
"reservation_end_time": null,
"short_id": null,
"deleted_at": null,
"current_stage": null,
"document_draft": null,
"start_price_km": null,
"end_price_km": null,
"route_km": null,
"text_search": null,
"updated": null
}
],
"total": 0
}
Schema of the response body
{
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/OrderDBModel"
},
"type": "array",
"title": "Items"
},
"total": {
"type": "integer",
"title": "Total"
}
},
"type": "object",
"required": [
"items",
"total"
],
"title": "GenericGetListResponse[OrderDBModel]"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
PUT /active-orders/{order_id}/current_stage
Update Current Stage
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
order_id |
path | string | No |
Request body
{
"id": 0
}
Schema of the request body
{
"properties": {
"id": {
"type": "integer",
"title": "Id"
}
},
"type": "object",
"required": [
"id"
],
"title": "OrderStageSubmitModel"
}
Response 200 OK
{
"id": "string",
"auction_end_time": null,
"stops": null,
"peculiarities": null,
"cargo_type": null,
"truck_body": null,
"client_price": null,
"start_price": null,
"end_price": null,
"currency": null,
"currency_caption": null,
"vat_type": null,
"rate_step": null,
"status": null,
"note": null,
"external": null,
"client": null,
"assigned": null,
"carrier": null,
"driver": null,
"truck": null,
"trailer": null,
"documents": null,
"cancel_reason": null,
"etag": null,
"completed_stages": null,
"created_at": null,
"your_bid": null,
"best_bid": null,
"confirmation_end_time": null,
"reservation_end_time": null,
"short_id": null,
"deleted_at": null,
"current_stage": null,
"document_draft": null,
"start_price_km": null,
"end_price_km": null,
"route_km": null,
"text_search": null,
"updated": null
}
Schema of the response body
{
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"auction_end_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Auction End Time"
},
"stops": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/StopModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Stops"
},
"peculiarities": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"title": "Peculiarities"
},
"cargo_type": {
"anyOf": [
{
"type": "string",
"maxLength": 2048
},
{
"type": "null"
}
],
"title": "Cargo Type"
},
"truck_body": {
"anyOf": [
{
"$ref": "#/components/schemas/BodySettingsModel"
},
{
"type": "null"
}
]
},
"client_price": {
"anyOf": [
{
"type": "integer",
"minimum": 0.0
},
{
"type": "null"
}
],
"title": "Client Price"
},
"start_price": {
"anyOf": [
{
"type": "integer",
"exclusiveMaximum": 100000000.0,
"exclusiveMinimum": 0.0
},
{
"type": "null"
}
],
"title": "Start Price"
},
"end_price": {
"anyOf": [
{
"type": "integer",
"exclusiveMaximum": 100000000.0,
"exclusiveMinimum": 0.0
},
{
"type": "null"
}
],
"title": "End Price"
},
"currency": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency"
},
"currency_caption": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency Caption"
},
"vat_type": {
"anyOf": [
{
"$ref": "#/components/schemas/VATType"
},
{
"type": "null"
}
]
},
"rate_step": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Rate Step"
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderStatus"
},
{
"type": "null"
}
]
},
"note": {
"anyOf": [
{
"type": "string",
"maxLength": 8192
},
{
"type": "null"
}
],
"title": "Note"
},
"external": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderExternalData"
},
{
"type": "null"
}
]
},
"client": {
"anyOf": [
{
"$ref": "#/components/schemas/ClientDBModel"
},
{
"type": "null"
}
]
},
"assigned": {
"anyOf": [
{
"$ref": "#/components/schemas/AssignedModel"
},
{
"type": "null"
}
]
},
"carrier": {
"anyOf": [
{
"$ref": "#/components/schemas/OrganizationDBModel"
},
{
"type": "null"
}
]
},
"driver": {
"anyOf": [
{
"$ref": "#/components/schemas/DriverDBModel"
},
{
"type": "null"
}
]
},
"truck": {
"anyOf": [
{
"$ref": "#/components/schemas/TruckDBModel"
},
{
"type": "null"
}
]
},
"trailer": {
"anyOf": [
{
"$ref": "#/components/schemas/TrailerDBModel"
},
{
"type": "null"
}
]
},
"documents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/DocumentDBModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Documents"
},
"cancel_reason": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"title": "Cancel Reason"
},
"etag": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Etag"
},
"completed_stages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/OrderStageModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Completed Stages"
},
"created_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At"
},
"your_bid": {
"anyOf": [
{
"$ref": "#/components/schemas/BidDBModel"
},
{
"type": "null"
}
]
},
"best_bid": {
"anyOf": [
{
"$ref": "#/components/schemas/BidDBModel"
},
{
"type": "null"
}
]
},
"confirmation_end_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Confirmation End Time"
},
"reservation_end_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Reservation End Time"
},
"short_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Short Id"
},
"deleted_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Deleted At"
},
"current_stage": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderStageModel"
},
{
"type": "null"
}
]
},
"document_draft": {
"anyOf": [
{
"$ref": "#/components/schemas/DocumentDBModel"
},
{
"type": "null"
}
]
},
"start_price_km": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Start Price Km"
},
"end_price_km": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "End Price Km"
},
"route_km": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Route Km"
},
"text_search": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Text Search"
},
"updated": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/UpdateMetadata"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Updated"
}
},
"type": "object",
"title": "OrderDBModel"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /active-orders/{order_id}
Get Active By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
order_id |
path | string | No | ||
projection |
query | string | No |
Response 200 OK
{
"id": "string",
"auction_end_time": null,
"stops": null,
"peculiarities": null,
"cargo_type": null,
"truck_body": null,
"client_price": null,
"start_price": null,
"end_price": null,
"currency": null,
"currency_caption": null,
"vat_type": null,
"rate_step": null,
"status": null,
"note": null,
"external": null,
"client": null,
"assigned": null,
"carrier": null,
"driver": null,
"truck": null,
"trailer": null,
"documents": null,
"cancel_reason": null,
"etag": null,
"completed_stages": null,
"created_at": null,
"your_bid": null,
"best_bid": null,
"confirmation_end_time": null,
"reservation_end_time": null,
"short_id": null,
"deleted_at": null,
"current_stage": null,
"document_draft": null,
"start_price_km": null,
"end_price_km": null,
"route_km": null,
"text_search": null,
"updated": null
}
Schema of the response body
{
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"auction_end_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Auction End Time"
},
"stops": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/StopModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Stops"
},
"peculiarities": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"title": "Peculiarities"
},
"cargo_type": {
"anyOf": [
{
"type": "string",
"maxLength": 2048
},
{
"type": "null"
}
],
"title": "Cargo Type"
},
"truck_body": {
"anyOf": [
{
"$ref": "#/components/schemas/BodySettingsModel"
},
{
"type": "null"
}
]
},
"client_price": {
"anyOf": [
{
"type": "integer",
"minimum": 0.0
},
{
"type": "null"
}
],
"title": "Client Price"
},
"start_price": {
"anyOf": [
{
"type": "integer",
"exclusiveMaximum": 100000000.0,
"exclusiveMinimum": 0.0
},
{
"type": "null"
}
],
"title": "Start Price"
},
"end_price": {
"anyOf": [
{
"type": "integer",
"exclusiveMaximum": 100000000.0,
"exclusiveMinimum": 0.0
},
{
"type": "null"
}
],
"title": "End Price"
},
"currency": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency"
},
"currency_caption": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency Caption"
},
"vat_type": {
"anyOf": [
{
"$ref": "#/components/schemas/VATType"
},
{
"type": "null"
}
]
},
"rate_step": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Rate Step"
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderStatus"
},
{
"type": "null"
}
]
},
"note": {
"anyOf": [
{
"type": "string",
"maxLength": 8192
},
{
"type": "null"
}
],
"title": "Note"
},
"external": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderExternalData"
},
{
"type": "null"
}
]
},
"client": {
"anyOf": [
{
"$ref": "#/components/schemas/ClientDBModel"
},
{
"type": "null"
}
]
},
"assigned": {
"anyOf": [
{
"$ref": "#/components/schemas/AssignedModel"
},
{
"type": "null"
}
]
},
"carrier": {
"anyOf": [
{
"$ref": "#/components/schemas/OrganizationDBModel"
},
{
"type": "null"
}
]
},
"driver": {
"anyOf": [
{
"$ref": "#/components/schemas/DriverDBModel"
},
{
"type": "null"
}
]
},
"truck": {
"anyOf": [
{
"$ref": "#/components/schemas/TruckDBModel"
},
{
"type": "null"
}
]
},
"trailer": {
"anyOf": [
{
"$ref": "#/components/schemas/TrailerDBModel"
},
{
"type": "null"
}
]
},
"documents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/DocumentDBModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Documents"
},
"cancel_reason": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"title": "Cancel Reason"
},
"etag": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Etag"
},
"completed_stages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/OrderStageModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Completed Stages"
},
"created_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At"
},
"your_bid": {
"anyOf": [
{
"$ref": "#/components/schemas/BidDBModel"
},
{
"type": "null"
}
]
},
"best_bid": {
"anyOf": [
{
"$ref": "#/components/schemas/BidDBModel"
},
{
"type": "null"
}
]
},
"confirmation_end_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Confirmation End Time"
},
"reservation_end_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Reservation End Time"
},
"short_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Short Id"
},
"deleted_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Deleted At"
},
"current_stage": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderStageModel"
},
{
"type": "null"
}
]
},
"document_draft": {
"anyOf": [
{
"$ref": "#/components/schemas/DocumentDBModel"
},
{
"type": "null"
}
]
},
"start_price_km": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Start Price Km"
},
"end_price_km": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "End Price Km"
},
"route_km": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Route Km"
},
"text_search": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Text Search"
},
"updated": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/UpdateMetadata"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Updated"
}
},
"type": "object",
"title": "OrderDBModel"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 404 Not Found
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /archive
Get Archive
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
assignment |
query | string | No | ||
limit |
query | integer | 200 | No | |
projection |
query | string | No | ||
search |
query | string | No | ||
skip |
query | integer | 0 | No | |
sort |
query | string | No | ||
where |
query | string | No |
Response 200 OK
{
"items": [
{
"id": "string",
"auction_end_time": null,
"stops": null,
"peculiarities": null,
"cargo_type": null,
"truck_body": null,
"client_price": null,
"start_price": null,
"end_price": null,
"currency": null,
"currency_caption": null,
"vat_type": null,
"rate_step": null,
"status": null,
"note": null,
"external": null,
"client": null,
"assigned": null,
"carrier": null,
"driver": null,
"truck": null,
"trailer": null,
"documents": null,
"cancel_reason": null,
"etag": null,
"completed_stages": null,
"created_at": null,
"your_bid": null,
"best_bid": null,
"confirmation_end_time": null,
"reservation_end_time": null,
"short_id": null,
"deleted_at": null,
"current_stage": null,
"document_draft": null,
"start_price_km": null,
"end_price_km": null,
"route_km": null,
"text_search": null,
"updated": null
}
],
"total": 0
}
Schema of the response body
{
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/OrderDBModel"
},
"type": "array",
"title": "Items"
},
"total": {
"type": "integer",
"title": "Total"
}
},
"type": "object",
"required": [
"items",
"total"
],
"title": "GenericGetListResponse[OrderDBModel]"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /archive/xml
Export Archive As Xml
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
assignment |
query | string | No | ||
limit |
query | integer | 200 | No | |
projection |
query | string | No | ||
search |
query | string | No | ||
skip |
query | integer | 0 | No | |
sort |
query | string | No | ||
where |
query | string | No |
Response 200 OK
Schema of the response body
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /archive/xlsx
Export Archive As Xlsx
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
assignment |
query | string | No | ||
limit |
query | integer | 200 | No | |
projection |
query | string | No | ||
search |
query | string | No | ||
skip |
query | integer | 0 | No | |
sort |
query | string | No | ||
where |
query | string | No |
Response 200 OK
Schema of the response body
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /archive/statistics
Get Archive Statistics
Description
Each number in key represents how far ago starting period was.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No |
Response 200 OK
{
"graph": [
{
"key": 0,
"value": 0
}
],
"total": 0
}
Schema of the response body
{
"properties": {
"graph": {
"items": {
"$ref": "#/components/schemas/OneMonthStatsModel"
},
"type": "array",
"title": "Graph"
},
"total": {
"type": "integer",
"title": "Total"
}
},
"type": "object",
"required": [
"graph",
"total"
],
"title": "MonthlyStatisticsResponse"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
GET /archive/{order_id}
Get Archive By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
order_id |
path | string | No | ||
projection |
query | string | No |
Response 200 OK
{
"id": "string",
"auction_end_time": null,
"stops": null,
"peculiarities": null,
"cargo_type": null,
"truck_body": null,
"client_price": null,
"start_price": null,
"end_price": null,
"currency": null,
"currency_caption": null,
"vat_type": null,
"rate_step": null,
"status": null,
"note": null,
"external": null,
"client": null,
"assigned": null,
"carrier": null,
"driver": null,
"truck": null,
"trailer": null,
"documents": null,
"cancel_reason": null,
"etag": null,
"completed_stages": null,
"created_at": null,
"your_bid": null,
"best_bid": null,
"confirmation_end_time": null,
"reservation_end_time": null,
"short_id": null,
"deleted_at": null,
"current_stage": null,
"document_draft": null,
"start_price_km": null,
"end_price_km": null,
"route_km": null,
"text_search": null,
"updated": null
}
Schema of the response body
{
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"auction_end_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Auction End Time"
},
"stops": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/StopModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Stops"
},
"peculiarities": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"title": "Peculiarities"
},
"cargo_type": {
"anyOf": [
{
"type": "string",
"maxLength": 2048
},
{
"type": "null"
}
],
"title": "Cargo Type"
},
"truck_body": {
"anyOf": [
{
"$ref": "#/components/schemas/BodySettingsModel"
},
{
"type": "null"
}
]
},
"client_price": {
"anyOf": [
{
"type": "integer",
"minimum": 0.0
},
{
"type": "null"
}
],
"title": "Client Price"
},
"start_price": {
"anyOf": [
{
"type": "integer",
"exclusiveMaximum": 100000000.0,
"exclusiveMinimum": 0.0
},
{
"type": "null"
}
],
"title": "Start Price"
},
"end_price": {
"anyOf": [
{
"type": "integer",
"exclusiveMaximum": 100000000.0,
"exclusiveMinimum": 0.0
},
{
"type": "null"
}
],
"title": "End Price"
},
"currency": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency"
},
"currency_caption": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency Caption"
},
"vat_type": {
"anyOf": [
{
"$ref": "#/components/schemas/VATType"
},
{
"type": "null"
}
]
},
"rate_step": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Rate Step"
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderStatus"
},
{
"type": "null"
}
]
},
"note": {
"anyOf": [
{
"type": "string",
"maxLength": 8192
},
{
"type": "null"
}
],
"title": "Note"
},
"external": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderExternalData"
},
{
"type": "null"
}
]
},
"client": {
"anyOf": [
{
"$ref": "#/components/schemas/ClientDBModel"
},
{
"type": "null"
}
]
},
"assigned": {
"anyOf": [
{
"$ref": "#/components/schemas/AssignedModel"
},
{
"type": "null"
}
]
},
"carrier": {
"anyOf": [
{
"$ref": "#/components/schemas/OrganizationDBModel"
},
{
"type": "null"
}
]
},
"driver": {
"anyOf": [
{
"$ref": "#/components/schemas/DriverDBModel"
},
{
"type": "null"
}
]
},
"truck": {
"anyOf": [
{
"$ref": "#/components/schemas/TruckDBModel"
},
{
"type": "null"
}
]
},
"trailer": {
"anyOf": [
{
"$ref": "#/components/schemas/TrailerDBModel"
},
{
"type": "null"
}
]
},
"documents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/DocumentDBModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Documents"
},
"cancel_reason": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"title": "Cancel Reason"
},
"etag": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Etag"
},
"completed_stages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/OrderStageModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Completed Stages"
},
"created_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At"
},
"your_bid": {
"anyOf": [
{
"$ref": "#/components/schemas/BidDBModel"
},
{
"type": "null"
}
]
},
"best_bid": {
"anyOf": [
{
"$ref": "#/components/schemas/BidDBModel"
},
{
"type": "null"
}
]
},
"confirmation_end_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Confirmation End Time"
},
"reservation_end_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Reservation End Time"
},
"short_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Short Id"
},
"deleted_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Deleted At"
},
"current_stage": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderStageModel"
},
{
"type": "null"
}
]
},
"document_draft": {
"anyOf": [
{
"$ref": "#/components/schemas/DocumentDBModel"
},
{
"type": "null"
}
]
},
"start_price_km": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Start Price Km"
},
"end_price_km": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "End Price Km"
},
"route_km": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Route Km"
},
"text_search": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Text Search"
},
"updated": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/UpdateMetadata"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Updated"
}
},
"type": "object",
"title": "OrderDBModel"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 404 Not Found
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /orders/{order_id}/recommendations
Get Recommendations For Order
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
order_id |
path | string | No |
Response 200 OK
{
"items": [
{
"id": "string",
"auction_end_time": null,
"stops": null,
"peculiarities": null,
"cargo_type": null,
"truck_body": null,
"client_price": null,
"start_price": null,
"end_price": null,
"currency": null,
"currency_caption": null,
"vat_type": null,
"rate_step": null,
"status": null,
"note": null,
"external": null,
"client": null,
"assigned": null,
"carrier": null,
"driver": null,
"truck": null,
"trailer": null,
"documents": null,
"cancel_reason": null,
"etag": null,
"completed_stages": null,
"created_at": null,
"your_bid": null,
"best_bid": null,
"confirmation_end_time": null,
"reservation_end_time": null,
"short_id": null,
"deleted_at": null,
"current_stage": null,
"document_draft": null,
"start_price_km": null,
"end_price_km": null,
"route_km": null,
"text_search": null,
"updated": null,
"distance_km": 0,
"time_gap_hours": 0
}
],
"total": 0
}
Schema of the response body
{
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/Recommendation"
},
"type": "array",
"title": "Items"
},
"total": {
"type": "integer",
"title": "Total"
}
},
"type": "object",
"required": [
"items",
"total"
],
"title": "GenericGetListResponse[Recommendation]"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /orders/recommendations
Get All Recommendations Resp
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
assignment |
query | string | No | ||
limit |
query | integer | 200 | No | |
projection |
query | string | No | ||
search |
query | string | No | ||
skip |
query | integer | 0 | No | |
sort |
query | string | No | ||
where |
query | string | No |
Response 200 OK
{
"items": [
{
"id": "string",
"auction_end_time": null,
"stops": null,
"peculiarities": null,
"cargo_type": null,
"truck_body": null,
"client_price": null,
"start_price": null,
"end_price": null,
"currency": null,
"currency_caption": null,
"vat_type": null,
"rate_step": null,
"status": null,
"note": null,
"external": null,
"client": null,
"assigned": null,
"carrier": null,
"driver": null,
"truck": null,
"trailer": null,
"documents": null,
"cancel_reason": null,
"etag": null,
"completed_stages": null,
"created_at": null,
"your_bid": null,
"best_bid": null,
"confirmation_end_time": null,
"reservation_end_time": null,
"short_id": null,
"deleted_at": null,
"current_stage": null,
"document_draft": null,
"start_price_km": null,
"end_price_km": null,
"route_km": null,
"text_search": null,
"updated": null,
"distance_km": 0,
"time_gap_hours": 0
}
],
"total": 0
}
Schema of the response body
{
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/Recommendation"
},
"type": "array",
"title": "Items"
},
"total": {
"type": "integer",
"title": "Total"
}
},
"type": "object",
"required": [
"items",
"total"
],
"title": "GenericGetListResponse[Recommendation]"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
PUT /canceled-orders/{order_ids}/to-trash
Utilize Canceled
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
order_ids |
path | string | No |
Response 200 OK
{
"raised_ids": {}
}
Schema of the response body
{
"properties": {
"raised_ids": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Raised Ids"
}
},
"type": "object",
"required": [
"raised_ids"
],
"title": "MultiselectError"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 404 Not Found
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
PUT /canceled-orders/{order_ids}/to-exchange
Cancelled To Exchange
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
order_ids |
path | string | No |
Request body
Schema of the request body
{
"anyOf": [
{
"$ref": "#/components/schemas/OrderUpdateModel"
},
{
"type": "null"
}
],
"title": "Order"
}
Response 200 OK
{
"raised_ids": {}
}
Schema of the response body
{
"properties": {
"raised_ids": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Raised Ids"
}
},
"type": "object",
"required": [
"raised_ids"
],
"title": "MultiselectError"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 404 Not Found
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
PUT /canceled-orders/{order_ids}/to-buffer
Cancelled To Buffer
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
order_ids |
path | string | No |
Request body
Schema of the request body
{
"anyOf": [
{
"$ref": "#/components/schemas/OrderUpdateModel"
},
{
"type": "null"
}
],
"title": "Order"
}
Response 200 OK
{
"raised_ids": {}
}
Schema of the response body
{
"properties": {
"raised_ids": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Raised Ids"
}
},
"type": "object",
"required": [
"raised_ids"
],
"title": "MultiselectError"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 404 Not Found
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
PUT /canceled-orders/{order_ids}/to-appointment
Cancelled To Appointment
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
order_ids |
path | string | No |
Request body
Schema of the request body
{
"anyOf": [
{
"$ref": "#/components/schemas/OrderUpdateModel"
},
{
"type": "null"
}
],
"title": "Order"
}
Response 200 OK
{
"raised_ids": {}
}
Schema of the response body
{
"properties": {
"raised_ids": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Raised Ids"
}
},
"type": "object",
"required": [
"raised_ids"
],
"title": "MultiselectError"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 404 Not Found
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
PUT /canceled-orders/{order_ids}/to-confirmed
Cancelled To Confirmed
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
order_ids |
path | string | No |
Request body
{
"auction_end_time": null,
"stops": null,
"peculiarities": null,
"cargo_type": null,
"truck_body": null,
"client_price": null,
"start_price": null,
"end_price": null,
"currency": null,
"currency_caption": null,
"vat_type": null,
"rate_step": null,
"status": null,
"note": null,
"external": null,
"client": null,
"assigned": null,
"carrier": null,
"driver": null,
"truck": null,
"trailer": null,
"documents": null,
"cancel_reason": null,
"etag": null
}
Schema of the request body
{
"properties": {
"auction_end_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Auction End Time"
},
"stops": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/StopModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Stops"
},
"peculiarities": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"title": "Peculiarities"
},
"cargo_type": {
"anyOf": [
{
"type": "string",
"maxLength": 2048
},
{
"type": "null"
}
],
"title": "Cargo Type"
},
"truck_body": {
"anyOf": [
{
"$ref": "#/components/schemas/BodySettingsModel"
},
{
"type": "null"
}
]
},
"client_price": {
"anyOf": [
{
"type": "integer",
"minimum": 0.0
},
{
"type": "null"
}
],
"title": "Client Price"
},
"start_price": {
"anyOf": [
{
"type": "integer",
"exclusiveMaximum": 100000000.0,
"exclusiveMinimum": 0.0
},
{
"type": "null"
}
],
"title": "Start Price"
},
"end_price": {
"anyOf": [
{
"type": "integer",
"exclusiveMaximum": 100000000.0,
"exclusiveMinimum": 0.0
},
{
"type": "null"
}
],
"title": "End Price"
},
"currency": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency"
},
"currency_caption": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency Caption"
},
"vat_type": {
"anyOf": [
{
"$ref": "#/components/schemas/VATType"
},
{
"type": "null"
}
]
},
"rate_step": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Rate Step"
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderStatus"
},
{
"type": "null"
}
]
},
"note": {
"anyOf": [
{
"type": "string",
"maxLength": 8192
},
{
"type": "null"
}
],
"title": "Note"
},
"external": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderExternalData"
},
{
"type": "null"
}
]
},
"client": {
"anyOf": [
{
"$ref": "#/components/schemas/ClientCreateModel"
},
{
"$ref": "#/components/schemas/InsertByOIDModel"
},
{
"type": "null"
}
],
"title": "Client"
},
"assigned": {
"anyOf": [
{
"$ref": "#/components/schemas/AssignedCreateModel"
},
{
"type": "null"
}
]
},
"carrier": {
"anyOf": [
{
"$ref": "#/components/schemas/InsertByOIDModel"
},
{
"type": "null"
}
]
},
"driver": {
"anyOf": [
{
"$ref": "#/components/schemas/InsertByOIDModel"
},
{
"type": "null"
}
]
},
"truck": {
"anyOf": [
{
"$ref": "#/components/schemas/InsertByOIDModel"
},
{
"type": "null"
}
]
},
"trailer": {
"anyOf": [
{
"$ref": "#/components/schemas/InsertByOIDModel"
},
{
"type": "null"
}
]
},
"documents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/InsertByOIDModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Documents"
},
"cancel_reason": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"title": "Cancel Reason"
},
"etag": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Etag"
}
},
"type": "object",
"title": "OrderUpdateModel"
}
Response 200 OK
{
"raised_ids": {}
}
Schema of the response body
{
"properties": {
"raised_ids": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Raised Ids"
}
},
"type": "object",
"required": [
"raised_ids"
],
"title": "MultiselectError"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 404 Not Found
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /canceled-orders
Get Canceled Orders
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
assignment |
query | string | No | ||
limit |
query | integer | 200 | No | |
projection |
query | string | No | ||
search |
query | string | No | ||
skip |
query | integer | 0 | No | |
sort |
query | string | No | ||
where |
query | string | No |
Response 200 OK
{
"items": [
{
"id": "string",
"auction_end_time": null,
"stops": null,
"peculiarities": null,
"cargo_type": null,
"truck_body": null,
"client_price": null,
"start_price": null,
"end_price": null,
"currency": null,
"currency_caption": null,
"vat_type": null,
"rate_step": null,
"status": null,
"note": null,
"external": null,
"client": null,
"assigned": null,
"carrier": null,
"driver": null,
"truck": null,
"trailer": null,
"documents": null,
"cancel_reason": null,
"etag": null,
"completed_stages": null,
"created_at": null,
"your_bid": null,
"best_bid": null,
"confirmation_end_time": null,
"reservation_end_time": null,
"short_id": null,
"deleted_at": null,
"current_stage": null,
"document_draft": null,
"start_price_km": null,
"end_price_km": null,
"route_km": null,
"text_search": null,
"updated": null
}
],
"total": 0
}
Schema of the response body
{
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/OrderDBModel"
},
"type": "array",
"title": "Items"
},
"total": {
"type": "integer",
"title": "Total"
}
},
"type": "object",
"required": [
"items",
"total"
],
"title": "GenericGetListResponse[OrderDBModel]"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 404 Not Found
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /canceled-orders/{order_id}
Get Canceled By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
order_id |
path | string | No | ||
projection |
query | string | No |
Response 200 OK
{
"id": "string",
"auction_end_time": null,
"stops": null,
"peculiarities": null,
"cargo_type": null,
"truck_body": null,
"client_price": null,
"start_price": null,
"end_price": null,
"currency": null,
"currency_caption": null,
"vat_type": null,
"rate_step": null,
"status": null,
"note": null,
"external": null,
"client": null,
"assigned": null,
"carrier": null,
"driver": null,
"truck": null,
"trailer": null,
"documents": null,
"cancel_reason": null,
"etag": null,
"completed_stages": null,
"created_at": null,
"your_bid": null,
"best_bid": null,
"confirmation_end_time": null,
"reservation_end_time": null,
"short_id": null,
"deleted_at": null,
"current_stage": null,
"document_draft": null,
"start_price_km": null,
"end_price_km": null,
"route_km": null,
"text_search": null,
"updated": null
}
Schema of the response body
{
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"auction_end_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Auction End Time"
},
"stops": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/StopModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Stops"
},
"peculiarities": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"title": "Peculiarities"
},
"cargo_type": {
"anyOf": [
{
"type": "string",
"maxLength": 2048
},
{
"type": "null"
}
],
"title": "Cargo Type"
},
"truck_body": {
"anyOf": [
{
"$ref": "#/components/schemas/BodySettingsModel"
},
{
"type": "null"
}
]
},
"client_price": {
"anyOf": [
{
"type": "integer",
"minimum": 0.0
},
{
"type": "null"
}
],
"title": "Client Price"
},
"start_price": {
"anyOf": [
{
"type": "integer",
"exclusiveMaximum": 100000000.0,
"exclusiveMinimum": 0.0
},
{
"type": "null"
}
],
"title": "Start Price"
},
"end_price": {
"anyOf": [
{
"type": "integer",
"exclusiveMaximum": 100000000.0,
"exclusiveMinimum": 0.0
},
{
"type": "null"
}
],
"title": "End Price"
},
"currency": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency"
},
"currency_caption": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency Caption"
},
"vat_type": {
"anyOf": [
{
"$ref": "#/components/schemas/VATType"
},
{
"type": "null"
}
]
},
"rate_step": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Rate Step"
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderStatus"
},
{
"type": "null"
}
]
},
"note": {
"anyOf": [
{
"type": "string",
"maxLength": 8192
},
{
"type": "null"
}
],
"title": "Note"
},
"external": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderExternalData"
},
{
"type": "null"
}
]
},
"client": {
"anyOf": [
{
"$ref": "#/components/schemas/ClientDBModel"
},
{
"type": "null"
}
]
},
"assigned": {
"anyOf": [
{
"$ref": "#/components/schemas/AssignedModel"
},
{
"type": "null"
}
]
},
"carrier": {
"anyOf": [
{
"$ref": "#/components/schemas/OrganizationDBModel"
},
{
"type": "null"
}
]
},
"driver": {
"anyOf": [
{
"$ref": "#/components/schemas/DriverDBModel"
},
{
"type": "null"
}
]
},
"truck": {
"anyOf": [
{
"$ref": "#/components/schemas/TruckDBModel"
},
{
"type": "null"
}
]
},
"trailer": {
"anyOf": [
{
"$ref": "#/components/schemas/TrailerDBModel"
},
{
"type": "null"
}
]
},
"documents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/DocumentDBModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Documents"
},
"cancel_reason": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"title": "Cancel Reason"
},
"etag": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Etag"
},
"completed_stages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/OrderStageModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Completed Stages"
},
"created_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At"
},
"your_bid": {
"anyOf": [
{
"$ref": "#/components/schemas/BidDBModel"
},
{
"type": "null"
}
]
},
"best_bid": {
"anyOf": [
{
"$ref": "#/components/schemas/BidDBModel"
},
{
"type": "null"
}
]
},
"confirmation_end_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Confirmation End Time"
},
"reservation_end_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Reservation End Time"
},
"short_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Short Id"
},
"deleted_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Deleted At"
},
"current_stage": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderStageModel"
},
{
"type": "null"
}
]
},
"document_draft": {
"anyOf": [
{
"$ref": "#/components/schemas/DocumentDBModel"
},
{
"type": "null"
}
]
},
"start_price_km": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Start Price Km"
},
"end_price_km": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "End Price Km"
},
"route_km": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Route Km"
},
"text_search": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Text Search"
},
"updated": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/UpdateMetadata"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Updated"
}
},
"type": "object",
"title": "OrderDBModel"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 404 Not Found
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
PATCH /orders/{order_id}
Update Order
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
order_id |
path | string | No |
Request body
{
"auction_end_time": null,
"stops": null,
"peculiarities": null,
"cargo_type": null,
"truck_body": null,
"client_price": null,
"start_price": null,
"end_price": null,
"currency": null,
"currency_caption": null,
"vat_type": null,
"rate_step": null,
"status": null,
"note": null,
"external": null,
"client": null,
"assigned": null,
"carrier": null,
"driver": null,
"truck": null,
"trailer": null,
"documents": null,
"cancel_reason": null,
"etag": null
}
Schema of the request body
{
"properties": {
"auction_end_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Auction End Time"
},
"stops": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/StopModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Stops"
},
"peculiarities": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"title": "Peculiarities"
},
"cargo_type": {
"anyOf": [
{
"type": "string",
"maxLength": 2048
},
{
"type": "null"
}
],
"title": "Cargo Type"
},
"truck_body": {
"anyOf": [
{
"$ref": "#/components/schemas/BodySettingsModel"
},
{
"type": "null"
}
]
},
"client_price": {
"anyOf": [
{
"type": "integer",
"minimum": 0.0
},
{
"type": "null"
}
],
"title": "Client Price"
},
"start_price": {
"anyOf": [
{
"type": "integer",
"exclusiveMaximum": 100000000.0,
"exclusiveMinimum": 0.0
},
{
"type": "null"
}
],
"title": "Start Price"
},
"end_price": {
"anyOf": [
{
"type": "integer",
"exclusiveMaximum": 100000000.0,
"exclusiveMinimum": 0.0
},
{
"type": "null"
}
],
"title": "End Price"
},
"currency": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency"
},
"currency_caption": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency Caption"
},
"vat_type": {
"anyOf": [
{
"$ref": "#/components/schemas/VATType"
},
{
"type": "null"
}
]
},
"rate_step": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Rate Step"
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderStatus"
},
{
"type": "null"
}
]
},
"note": {
"anyOf": [
{
"type": "string",
"maxLength": 8192
},
{
"type": "null"
}
],
"title": "Note"
},
"external": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderExternalData"
},
{
"type": "null"
}
]
},
"client": {
"anyOf": [
{
"$ref": "#/components/schemas/ClientCreateModel"
},
{
"$ref": "#/components/schemas/InsertByOIDModel"
},
{
"type": "null"
}
],
"title": "Client"
},
"assigned": {
"anyOf": [
{
"$ref": "#/components/schemas/AssignedCreateModel"
},
{
"type": "null"
}
]
},
"carrier": {
"anyOf": [
{
"$ref": "#/components/schemas/InsertByOIDModel"
},
{
"type": "null"
}
]
},
"driver": {
"anyOf": [
{
"$ref": "#/components/schemas/InsertByOIDModel"
},
{
"type": "null"
}
]
},
"truck": {
"anyOf": [
{
"$ref": "#/components/schemas/InsertByOIDModel"
},
{
"type": "null"
}
]
},
"trailer": {
"anyOf": [
{
"$ref": "#/components/schemas/InsertByOIDModel"
},
{
"type": "null"
}
]
},
"documents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/InsertByOIDModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Documents"
},
"cancel_reason": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"title": "Cancel Reason"
},
"etag": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Etag"
}
},
"type": "object",
"title": "OrderUpdateModel"
}
Response 200 OK
{
"id": "string",
"auction_end_time": null,
"stops": null,
"peculiarities": null,
"cargo_type": null,
"truck_body": null,
"client_price": null,
"start_price": null,
"end_price": null,
"currency": null,
"currency_caption": null,
"vat_type": null,
"rate_step": null,
"status": null,
"note": null,
"external": null,
"client": null,
"assigned": null,
"carrier": null,
"driver": null,
"truck": null,
"trailer": null,
"documents": null,
"cancel_reason": null,
"etag": null,
"completed_stages": null,
"created_at": null,
"your_bid": null,
"best_bid": null,
"confirmation_end_time": null,
"reservation_end_time": null,
"short_id": null,
"deleted_at": null,
"current_stage": null,
"document_draft": null,
"start_price_km": null,
"end_price_km": null,
"route_km": null,
"text_search": null,
"updated": null
}
Schema of the response body
{
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"auction_end_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Auction End Time"
},
"stops": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/StopModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Stops"
},
"peculiarities": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"title": "Peculiarities"
},
"cargo_type": {
"anyOf": [
{
"type": "string",
"maxLength": 2048
},
{
"type": "null"
}
],
"title": "Cargo Type"
},
"truck_body": {
"anyOf": [
{
"$ref": "#/components/schemas/BodySettingsModel"
},
{
"type": "null"
}
]
},
"client_price": {
"anyOf": [
{
"type": "integer",
"minimum": 0.0
},
{
"type": "null"
}
],
"title": "Client Price"
},
"start_price": {
"anyOf": [
{
"type": "integer",
"exclusiveMaximum": 100000000.0,
"exclusiveMinimum": 0.0
},
{
"type": "null"
}
],
"title": "Start Price"
},
"end_price": {
"anyOf": [
{
"type": "integer",
"exclusiveMaximum": 100000000.0,
"exclusiveMinimum": 0.0
},
{
"type": "null"
}
],
"title": "End Price"
},
"currency": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency"
},
"currency_caption": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency Caption"
},
"vat_type": {
"anyOf": [
{
"$ref": "#/components/schemas/VATType"
},
{
"type": "null"
}
]
},
"rate_step": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Rate Step"
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderStatus"
},
{
"type": "null"
}
]
},
"note": {
"anyOf": [
{
"type": "string",
"maxLength": 8192
},
{
"type": "null"
}
],
"title": "Note"
},
"external": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderExternalData"
},
{
"type": "null"
}
]
},
"client": {
"anyOf": [
{
"$ref": "#/components/schemas/ClientDBModel"
},
{
"type": "null"
}
]
},
"assigned": {
"anyOf": [
{
"$ref": "#/components/schemas/AssignedModel"
},
{
"type": "null"
}
]
},
"carrier": {
"anyOf": [
{
"$ref": "#/components/schemas/OrganizationDBModel"
},
{
"type": "null"
}
]
},
"driver": {
"anyOf": [
{
"$ref": "#/components/schemas/DriverDBModel"
},
{
"type": "null"
}
]
},
"truck": {
"anyOf": [
{
"$ref": "#/components/schemas/TruckDBModel"
},
{
"type": "null"
}
]
},
"trailer": {
"anyOf": [
{
"$ref": "#/components/schemas/TrailerDBModel"
},
{
"type": "null"
}
]
},
"documents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/DocumentDBModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Documents"
},
"cancel_reason": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"title": "Cancel Reason"
},
"etag": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Etag"
},
"completed_stages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/OrderStageModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Completed Stages"
},
"created_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At"
},
"your_bid": {
"anyOf": [
{
"$ref": "#/components/schemas/BidDBModel"
},
{
"type": "null"
}
]
},
"best_bid": {
"anyOf": [
{
"$ref": "#/components/schemas/BidDBModel"
},
{
"type": "null"
}
]
},
"confirmation_end_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Confirmation End Time"
},
"reservation_end_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Reservation End Time"
},
"short_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Short Id"
},
"deleted_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Deleted At"
},
"current_stage": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderStageModel"
},
{
"type": "null"
}
]
},
"document_draft": {
"anyOf": [
{
"$ref": "#/components/schemas/DocumentDBModel"
},
{
"type": "null"
}
]
},
"start_price_km": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Start Price Km"
},
"end_price_km": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "End Price Km"
},
"route_km": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Route Km"
},
"text_search": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Text Search"
},
"updated": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/UpdateMetadata"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Updated"
}
},
"type": "object",
"title": "OrderDBModel"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /orders/{order_id}
Get Order By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
order_id |
path | string | No | ||
projection |
query | string | No |
Response 200 OK
{
"id": "string",
"auction_end_time": null,
"stops": null,
"peculiarities": null,
"cargo_type": null,
"truck_body": null,
"client_price": null,
"start_price": null,
"end_price": null,
"currency": null,
"currency_caption": null,
"vat_type": null,
"rate_step": null,
"status": null,
"note": null,
"external": null,
"client": null,
"assigned": null,
"carrier": null,
"driver": null,
"truck": null,
"trailer": null,
"documents": null,
"cancel_reason": null,
"etag": null,
"completed_stages": null,
"created_at": null,
"your_bid": null,
"best_bid": null,
"confirmation_end_time": null,
"reservation_end_time": null,
"short_id": null,
"deleted_at": null,
"current_stage": null,
"document_draft": null,
"start_price_km": null,
"end_price_km": null,
"route_km": null,
"text_search": null,
"updated": null,
"resource_check_passing": null
}
Schema of the response body
{
"properties": {
"id": {
"type": "string",
"title": "Id",
"default": "id"
},
"auction_end_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Auction End Time",
"default": "auction_end_time"
},
"stops": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/StopModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Stops",
"default": [
"stops"
]
},
"peculiarities": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Peculiarities",
"default": "peculiarities"
},
"cargo_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cargo Type",
"default": "cargo_type"
},
"truck_body": {
"anyOf": [
{
"$ref": "#/components/schemas/BodySettingsModel"
},
{
"type": "null"
}
],
"default": "truck_body"
},
"client_price": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Client Price",
"default": "client_price"
},
"start_price": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Start Price",
"default": "start_price"
},
"end_price": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "End Price",
"default": "end_price"
},
"currency": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"default": "currency"
},
"currency_caption": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency Caption",
"default": "currency_caption"
},
"vat_type": {
"anyOf": [
{
"$ref": "#/components/schemas/VATType"
},
{
"type": "null"
}
],
"default": "vat_type"
},
"rate_step": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Rate Step",
"default": "rate_step"
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderStatus"
},
{
"type": "null"
}
],
"default": "status"
},
"note": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Note",
"default": "note"
},
"external": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderExternalData"
},
{
"type": "null"
}
],
"default": "external"
},
"client": {
"anyOf": [
{
"$ref": "#/components/schemas/ClientDBModel"
},
{
"type": "null"
}
],
"default": "client"
},
"assigned": {
"anyOf": [
{
"$ref": "#/components/schemas/AssignedModel"
},
{
"type": "null"
}
],
"default": "assigned"
},
"carrier": {
"anyOf": [
{
"$ref": "#/components/schemas/OrganizationDBModel"
},
{
"type": "null"
}
],
"default": "carrier"
},
"driver": {
"anyOf": [
{
"$ref": "#/components/schemas/DriverDBModel"
},
{
"type": "null"
}
],
"default": "driver"
},
"truck": {
"anyOf": [
{
"$ref": "#/components/schemas/TruckDBModel"
},
{
"type": "null"
}
],
"default": "truck"
},
"trailer": {
"anyOf": [
{
"$ref": "#/components/schemas/TrailerDBModel"
},
{
"type": "null"
}
],
"default": "trailer"
},
"documents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/DocumentDBModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Documents",
"default": [
"documents"
]
},
"cancel_reason": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cancel Reason",
"default": "cancel_reason"
},
"etag": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Etag",
"default": "etag"
},
"completed_stages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/OrderStageModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Completed Stages",
"default": [
"completed_stages"
]
},
"created_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At",
"default": "created_at"
},
"your_bid": {
"anyOf": [
{
"$ref": "#/components/schemas/BidDBModel"
},
{
"type": "null"
}
],
"default": "your_bid"
},
"best_bid": {
"anyOf": [
{
"$ref": "#/components/schemas/BidDBModel"
},
{
"type": "null"
}
],
"default": "best_bid"
},
"confirmation_end_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Confirmation End Time",
"default": "confirmation_end_time"
},
"reservation_end_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Reservation End Time",
"default": "reservation_end_time"
},
"short_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Short Id",
"default": "short_id"
},
"deleted_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Deleted At",
"default": "deleted_at"
},
"current_stage": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderStageModel"
},
{
"type": "null"
}
],
"default": "current_stage"
},
"document_draft": {
"anyOf": [
{
"$ref": "#/components/schemas/DocumentDBModel"
},
{
"type": "null"
}
],
"default": "document_draft"
},
"start_price_km": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Start Price Km",
"default": "start_price_km"
},
"end_price_km": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "End Price Km",
"default": "end_price_km"
},
"route_km": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Route Km",
"default": "route_km"
},
"text_search": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Text Search",
"default": "text_search"
},
"updated": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/UpdateMetadata"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Updated",
"default": [
"updated"
]
},
"resource_check_passing": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Resource Check Passing"
}
},
"type": "object",
"title": "ResourceCheckOrderDBModel"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
PUT /orders/{order_ids}/to-exchange
Orders To Exchange
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
order_ids |
path | string | No |
Request body
Schema of the request body
{
"anyOf": [
{
"$ref": "#/components/schemas/OrderUpdateModel"
},
{
"type": "null"
}
],
"title": "Order"
}
Response 200 OK
{
"raised_ids": {}
}
Schema of the response body
{
"properties": {
"raised_ids": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Raised Ids"
}
},
"type": "object",
"required": [
"raised_ids"
],
"title": "MultiselectError"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /orders/{order_ids}/to-appointment
Orders To Appointment
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
order_ids |
path | string | No |
Request body
Schema of the request body
{
"anyOf": [
{
"$ref": "#/components/schemas/OrderUpdateModel"
},
{
"type": "null"
}
],
"title": "Order"
}
Response 200 OK
{
"raised_ids": {}
}
Schema of the response body
{
"properties": {
"raised_ids": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Raised Ids"
}
},
"type": "object",
"required": [
"raised_ids"
],
"title": "MultiselectError"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
PUT /orders/{order_ids}/to-canceled
Move To Canceled Order
Description
Accepts cancel_reason(required) and assigned(optional)
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
order_ids |
path | string | No |
Request body
{
"auction_end_time": null,
"stops": null,
"peculiarities": null,
"cargo_type": null,
"truck_body": null,
"client_price": null,
"start_price": null,
"end_price": null,
"currency": null,
"currency_caption": null,
"vat_type": null,
"rate_step": null,
"status": null,
"note": null,
"external": null,
"client": null,
"assigned": null,
"carrier": null,
"driver": null,
"truck": null,
"trailer": null,
"documents": null,
"cancel_reason": null,
"etag": null
}
Schema of the request body
{
"properties": {
"auction_end_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Auction End Time"
},
"stops": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/StopModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Stops"
},
"peculiarities": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"title": "Peculiarities"
},
"cargo_type": {
"anyOf": [
{
"type": "string",
"maxLength": 2048
},
{
"type": "null"
}
],
"title": "Cargo Type"
},
"truck_body": {
"anyOf": [
{
"$ref": "#/components/schemas/BodySettingsModel"
},
{
"type": "null"
}
]
},
"client_price": {
"anyOf": [
{
"type": "integer",
"minimum": 0.0
},
{
"type": "null"
}
],
"title": "Client Price"
},
"start_price": {
"anyOf": [
{
"type": "integer",
"exclusiveMaximum": 100000000.0,
"exclusiveMinimum": 0.0
},
{
"type": "null"
}
],
"title": "Start Price"
},
"end_price": {
"anyOf": [
{
"type": "integer",
"exclusiveMaximum": 100000000.0,
"exclusiveMinimum": 0.0
},
{
"type": "null"
}
],
"title": "End Price"
},
"currency": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency"
},
"currency_caption": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency Caption"
},
"vat_type": {
"anyOf": [
{
"$ref": "#/components/schemas/VATType"
},
{
"type": "null"
}
]
},
"rate_step": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Rate Step"
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderStatus"
},
{
"type": "null"
}
]
},
"note": {
"anyOf": [
{
"type": "string",
"maxLength": 8192
},
{
"type": "null"
}
],
"title": "Note"
},
"external": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderExternalData"
},
{
"type": "null"
}
]
},
"client": {
"anyOf": [
{
"$ref": "#/components/schemas/ClientCreateModel"
},
{
"$ref": "#/components/schemas/InsertByOIDModel"
},
{
"type": "null"
}
],
"title": "Client"
},
"assigned": {
"anyOf": [
{
"$ref": "#/components/schemas/AssignedCreateModel"
},
{
"type": "null"
}
]
},
"carrier": {
"anyOf": [
{
"$ref": "#/components/schemas/InsertByOIDModel"
},
{
"type": "null"
}
]
},
"driver": {
"anyOf": [
{
"$ref": "#/components/schemas/InsertByOIDModel"
},
{
"type": "null"
}
]
},
"truck": {
"anyOf": [
{
"$ref": "#/components/schemas/InsertByOIDModel"
},
{
"type": "null"
}
]
},
"trailer": {
"anyOf": [
{
"$ref": "#/components/schemas/InsertByOIDModel"
},
{
"type": "null"
}
]
},
"documents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/InsertByOIDModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Documents"
},
"cancel_reason": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"title": "Cancel Reason"
},
"etag": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Etag"
}
},
"type": "object",
"title": "OrderUpdateModel"
}
Response 200 OK
{
"raised_ids": {}
}
Schema of the response body
{
"properties": {
"raised_ids": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Raised Ids"
}
},
"type": "object",
"required": [
"raised_ids"
],
"title": "MultiselectError"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
PUT /orders/{order_ids}/to-confirmed
Assign Carrier
Description
Accepts carrier(required), assigned(optional).
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
order_ids |
path | string | No |
Request body
{
"auction_end_time": null,
"stops": null,
"peculiarities": null,
"cargo_type": null,
"truck_body": null,
"client_price": null,
"start_price": null,
"end_price": null,
"currency": null,
"currency_caption": null,
"vat_type": null,
"rate_step": null,
"status": null,
"note": null,
"external": null,
"client": null,
"assigned": null,
"carrier": null,
"driver": null,
"truck": null,
"trailer": null,
"documents": null,
"cancel_reason": null,
"etag": null
}
Schema of the request body
{
"properties": {
"auction_end_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Auction End Time"
},
"stops": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/StopModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Stops"
},
"peculiarities": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"title": "Peculiarities"
},
"cargo_type": {
"anyOf": [
{
"type": "string",
"maxLength": 2048
},
{
"type": "null"
}
],
"title": "Cargo Type"
},
"truck_body": {
"anyOf": [
{
"$ref": "#/components/schemas/BodySettingsModel"
},
{
"type": "null"
}
]
},
"client_price": {
"anyOf": [
{
"type": "integer",
"minimum": 0.0
},
{
"type": "null"
}
],
"title": "Client Price"
},
"start_price": {
"anyOf": [
{
"type": "integer",
"exclusiveMaximum": 100000000.0,
"exclusiveMinimum": 0.0
},
{
"type": "null"
}
],
"title": "Start Price"
},
"end_price": {
"anyOf": [
{
"type": "integer",
"exclusiveMaximum": 100000000.0,
"exclusiveMinimum": 0.0
},
{
"type": "null"
}
],
"title": "End Price"
},
"currency": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency"
},
"currency_caption": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency Caption"
},
"vat_type": {
"anyOf": [
{
"$ref": "#/components/schemas/VATType"
},
{
"type": "null"
}
]
},
"rate_step": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Rate Step"
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderStatus"
},
{
"type": "null"
}
]
},
"note": {
"anyOf": [
{
"type": "string",
"maxLength": 8192
},
{
"type": "null"
}
],
"title": "Note"
},
"external": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderExternalData"
},
{
"type": "null"
}
]
},
"client": {
"anyOf": [
{
"$ref": "#/components/schemas/ClientCreateModel"
},
{
"$ref": "#/components/schemas/InsertByOIDModel"
},
{
"type": "null"
}
],
"title": "Client"
},
"assigned": {
"anyOf": [
{
"$ref": "#/components/schemas/AssignedCreateModel"
},
{
"type": "null"
}
]
},
"carrier": {
"anyOf": [
{
"$ref": "#/components/schemas/InsertByOIDModel"
},
{
"type": "null"
}
]
},
"driver": {
"anyOf": [
{
"$ref": "#/components/schemas/InsertByOIDModel"
},
{
"type": "null"
}
]
},
"truck": {
"anyOf": [
{
"$ref": "#/components/schemas/InsertByOIDModel"
},
{
"type": "null"
}
]
},
"trailer": {
"anyOf": [
{
"$ref": "#/components/schemas/InsertByOIDModel"
},
{
"type": "null"
}
]
},
"documents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/InsertByOIDModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Documents"
},
"cancel_reason": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"title": "Cancel Reason"
},
"etag": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Etag"
}
},
"type": "object",
"title": "OrderUpdateModel"
}
Response 200 OK
{
"raised_ids": {}
}
Schema of the response body
{
"properties": {
"raised_ids": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Raised Ids"
}
},
"type": "object",
"required": [
"raised_ids"
],
"title": "MultiselectError"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 404 Not Found
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
PUT /orders/{order_ids}/assigned/company
Assign Company
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
order_ids |
path | string | No |
Request body
{
"auction_end_time": null,
"stops": null,
"peculiarities": null,
"cargo_type": null,
"truck_body": null,
"client_price": null,
"start_price": null,
"end_price": null,
"currency": null,
"currency_caption": null,
"vat_type": null,
"rate_step": null,
"status": null,
"note": null,
"external": null,
"client": null,
"assigned": null,
"carrier": null,
"driver": null,
"truck": null,
"trailer": null,
"documents": null,
"cancel_reason": null,
"etag": null
}
Schema of the request body
{
"properties": {
"auction_end_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Auction End Time"
},
"stops": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/StopModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Stops"
},
"peculiarities": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"title": "Peculiarities"
},
"cargo_type": {
"anyOf": [
{
"type": "string",
"maxLength": 2048
},
{
"type": "null"
}
],
"title": "Cargo Type"
},
"truck_body": {
"anyOf": [
{
"$ref": "#/components/schemas/BodySettingsModel"
},
{
"type": "null"
}
]
},
"client_price": {
"anyOf": [
{
"type": "integer",
"minimum": 0.0
},
{
"type": "null"
}
],
"title": "Client Price"
},
"start_price": {
"anyOf": [
{
"type": "integer",
"exclusiveMaximum": 100000000.0,
"exclusiveMinimum": 0.0
},
{
"type": "null"
}
],
"title": "Start Price"
},
"end_price": {
"anyOf": [
{
"type": "integer",
"exclusiveMaximum": 100000000.0,
"exclusiveMinimum": 0.0
},
{
"type": "null"
}
],
"title": "End Price"
},
"currency": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency"
},
"currency_caption": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency Caption"
},
"vat_type": {
"anyOf": [
{
"$ref": "#/components/schemas/VATType"
},
{
"type": "null"
}
]
},
"rate_step": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Rate Step"
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderStatus"
},
{
"type": "null"
}
]
},
"note": {
"anyOf": [
{
"type": "string",
"maxLength": 8192
},
{
"type": "null"
}
],
"title": "Note"
},
"external": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderExternalData"
},
{
"type": "null"
}
]
},
"client": {
"anyOf": [
{
"$ref": "#/components/schemas/ClientCreateModel"
},
{
"$ref": "#/components/schemas/InsertByOIDModel"
},
{
"type": "null"
}
],
"title": "Client"
},
"assigned": {
"anyOf": [
{
"$ref": "#/components/schemas/AssignedCreateModel"
},
{
"type": "null"
}
]
},
"carrier": {
"anyOf": [
{
"$ref": "#/components/schemas/InsertByOIDModel"
},
{
"type": "null"
}
]
},
"driver": {
"anyOf": [
{
"$ref": "#/components/schemas/InsertByOIDModel"
},
{
"type": "null"
}
]
},
"truck": {
"anyOf": [
{
"$ref": "#/components/schemas/InsertByOIDModel"
},
{
"type": "null"
}
]
},
"trailer": {
"anyOf": [
{
"$ref": "#/components/schemas/InsertByOIDModel"
},
{
"type": "null"
}
]
},
"documents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/InsertByOIDModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Documents"
},
"cancel_reason": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"title": "Cancel Reason"
},
"etag": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Etag"
}
},
"type": "object",
"title": "OrderUpdateModel"
}
Response 200 OK
{
"raised_ids": {}
}
Schema of the response body
{
"properties": {
"raised_ids": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Raised Ids"
}
},
"type": "object",
"required": [
"raised_ids"
],
"title": "MultiselectError"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /orders
Get Orders
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
assignment |
query | string | No | ||
limit |
query | integer | 200 | No | |
projection |
query | string | No | ||
search |
query | string | No | ||
skip |
query | integer | 0 | No | |
sort |
query | string | No | ||
where |
query | string | No |
Response 200 OK
{
"items": [
{
"id": "string",
"auction_end_time": null,
"stops": null,
"peculiarities": null,
"cargo_type": null,
"truck_body": null,
"client_price": null,
"start_price": null,
"end_price": null,
"currency": null,
"currency_caption": null,
"vat_type": null,
"rate_step": null,
"status": null,
"note": null,
"external": null,
"client": null,
"assigned": null,
"carrier": null,
"driver": null,
"truck": null,
"trailer": null,
"documents": null,
"cancel_reason": null,
"etag": null,
"completed_stages": null,
"created_at": null,
"your_bid": null,
"best_bid": null,
"confirmation_end_time": null,
"reservation_end_time": null,
"short_id": null,
"deleted_at": null,
"current_stage": null,
"document_draft": null,
"start_price_km": null,
"end_price_km": null,
"route_km": null,
"text_search": null,
"updated": null
}
],
"total": 0
}
Schema of the response body
{
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/OrderDBModel"
},
"type": "array",
"title": "Items"
},
"total": {
"type": "integer",
"title": "Total"
}
},
"type": "object",
"required": [
"items",
"total"
],
"title": "GenericGetListResponse[OrderDBModel]"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
PUT /orders/{order_ids}/to-trash
Multi Trash
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
order_ids |
path | string | No |
Response 200 OK
true
Schema of the response body
{
"type": "boolean",
"title": "Response Multi Trash Orders Order Ids To Trash Put"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
PUT /orders/{order_id}/generate-document
Apply For Draft
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
order_id |
path | string | No |
Request body
{
"auction_end_time": null,
"stops": null,
"peculiarities": null,
"cargo_type": null,
"truck_body": null,
"client_price": null,
"start_price": null,
"end_price": null,
"currency": null,
"currency_caption": null,
"vat_type": null,
"rate_step": null,
"status": null,
"note": null,
"external": null,
"client": null,
"assigned": null,
"carrier": null,
"driver": null,
"truck": null,
"trailer": null,
"documents": null,
"cancel_reason": null,
"etag": null
}
Schema of the request body
{
"properties": {
"auction_end_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Auction End Time"
},
"stops": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/StopModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Stops"
},
"peculiarities": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"title": "Peculiarities"
},
"cargo_type": {
"anyOf": [
{
"type": "string",
"maxLength": 2048
},
{
"type": "null"
}
],
"title": "Cargo Type"
},
"truck_body": {
"anyOf": [
{
"$ref": "#/components/schemas/BodySettingsModel"
},
{
"type": "null"
}
]
},
"client_price": {
"anyOf": [
{
"type": "integer",
"minimum": 0.0
},
{
"type": "null"
}
],
"title": "Client Price"
},
"start_price": {
"anyOf": [
{
"type": "integer",
"exclusiveMaximum": 100000000.0,
"exclusiveMinimum": 0.0
},
{
"type": "null"
}
],
"title": "Start Price"
},
"end_price": {
"anyOf": [
{
"type": "integer",
"exclusiveMaximum": 100000000.0,
"exclusiveMinimum": 0.0
},
{
"type": "null"
}
],
"title": "End Price"
},
"currency": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency"
},
"currency_caption": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency Caption"
},
"vat_type": {
"anyOf": [
{
"$ref": "#/components/schemas/VATType"
},
{
"type": "null"
}
]
},
"rate_step": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Rate Step"
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderStatus"
},
{
"type": "null"
}
]
},
"note": {
"anyOf": [
{
"type": "string",
"maxLength": 8192
},
{
"type": "null"
}
],
"title": "Note"
},
"external": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderExternalData"
},
{
"type": "null"
}
]
},
"client": {
"anyOf": [
{
"$ref": "#/components/schemas/ClientCreateModel"
},
{
"$ref": "#/components/schemas/InsertByOIDModel"
},
{
"type": "null"
}
],
"title": "Client"
},
"assigned": {
"anyOf": [
{
"$ref": "#/components/schemas/AssignedCreateModel"
},
{
"type": "null"
}
]
},
"carrier": {
"anyOf": [
{
"$ref": "#/components/schemas/InsertByOIDModel"
},
{
"type": "null"
}
]
},
"driver": {
"anyOf": [
{
"$ref": "#/components/schemas/InsertByOIDModel"
},
{
"type": "null"
}
]
},
"truck": {
"anyOf": [
{
"$ref": "#/components/schemas/InsertByOIDModel"
},
{
"type": "null"
}
]
},
"trailer": {
"anyOf": [
{
"$ref": "#/components/schemas/InsertByOIDModel"
},
{
"type": "null"
}
]
},
"documents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/DocumentCreateModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Documents"
},
"cancel_reason": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"title": "Cancel Reason"
},
"etag": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Etag"
}
},
"type": "object",
"title": "ConfirmedOrderUpdateModel"
}
Response 200 OK
{
"id": "string",
"auction_end_time": null,
"stops": null,
"peculiarities": null,
"cargo_type": null,
"truck_body": null,
"client_price": null,
"start_price": null,
"end_price": null,
"currency": null,
"currency_caption": null,
"vat_type": null,
"rate_step": null,
"status": null,
"note": null,
"external": null,
"client": null,
"assigned": null,
"carrier": null,
"driver": null,
"truck": null,
"trailer": null,
"documents": null,
"cancel_reason": null,
"etag": null,
"completed_stages": null,
"created_at": null,
"your_bid": null,
"best_bid": null,
"confirmation_end_time": null,
"reservation_end_time": null,
"short_id": null,
"deleted_at": null,
"current_stage": null,
"document_draft": null,
"start_price_km": null,
"end_price_km": null,
"route_km": null,
"text_search": null,
"updated": null
}
Schema of the response body
{
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"auction_end_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Auction End Time"
},
"stops": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/StopModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Stops"
},
"peculiarities": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"title": "Peculiarities"
},
"cargo_type": {
"anyOf": [
{
"type": "string",
"maxLength": 2048
},
{
"type": "null"
}
],
"title": "Cargo Type"
},
"truck_body": {
"anyOf": [
{
"$ref": "#/components/schemas/BodySettingsModel"
},
{
"type": "null"
}
]
},
"client_price": {
"anyOf": [
{
"type": "integer",
"minimum": 0.0
},
{
"type": "null"
}
],
"title": "Client Price"
},
"start_price": {
"anyOf": [
{
"type": "integer",
"exclusiveMaximum": 100000000.0,
"exclusiveMinimum": 0.0
},
{
"type": "null"
}
],
"title": "Start Price"
},
"end_price": {
"anyOf": [
{
"type": "integer",
"exclusiveMaximum": 100000000.0,
"exclusiveMinimum": 0.0
},
{
"type": "null"
}
],
"title": "End Price"
},
"currency": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency"
},
"currency_caption": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency Caption"
},
"vat_type": {
"anyOf": [
{
"$ref": "#/components/schemas/VATType"
},
{
"type": "null"
}
]
},
"rate_step": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Rate Step"
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderStatus"
},
{
"type": "null"
}
]
},
"note": {
"anyOf": [
{
"type": "string",
"maxLength": 8192
},
{
"type": "null"
}
],
"title": "Note"
},
"external": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderExternalData"
},
{
"type": "null"
}
]
},
"client": {
"anyOf": [
{
"$ref": "#/components/schemas/ClientDBModel"
},
{
"type": "null"
}
]
},
"assigned": {
"anyOf": [
{
"$ref": "#/components/schemas/AssignedModel"
},
{
"type": "null"
}
]
},
"carrier": {
"anyOf": [
{
"$ref": "#/components/schemas/OrganizationDBModel"
},
{
"type": "null"
}
]
},
"driver": {
"anyOf": [
{
"$ref": "#/components/schemas/DriverDBModel"
},
{
"type": "null"
}
]
},
"truck": {
"anyOf": [
{
"$ref": "#/components/schemas/TruckDBModel"
},
{
"type": "null"
}
]
},
"trailer": {
"anyOf": [
{
"$ref": "#/components/schemas/TrailerDBModel"
},
{
"type": "null"
}
]
},
"documents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/DocumentDBModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Documents"
},
"cancel_reason": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"title": "Cancel Reason"
},
"etag": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Etag"
},
"completed_stages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/OrderStageModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Completed Stages"
},
"created_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At"
},
"your_bid": {
"anyOf": [
{
"$ref": "#/components/schemas/BidDBModel"
},
{
"type": "null"
}
]
},
"best_bid": {
"anyOf": [
{
"$ref": "#/components/schemas/BidDBModel"
},
{
"type": "null"
}
]
},
"confirmation_end_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Confirmation End Time"
},
"reservation_end_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Reservation End Time"
},
"short_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Short Id"
},
"deleted_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Deleted At"
},
"current_stage": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderStageModel"
},
{
"type": "null"
}
]
},
"document_draft": {
"anyOf": [
{
"$ref": "#/components/schemas/DocumentDBModel"
},
{
"type": "null"
}
]
},
"start_price_km": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Start Price Km"
},
"end_price_km": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "End Price Km"
},
"route_km": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Route Km"
},
"text_search": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Text Search"
},
"updated": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/UpdateMetadata"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Updated"
}
},
"type": "object",
"title": "OrderDBModel"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
PUT /orders/{order_ids}/to-active
Put Order To Active
Description
Throws Not Found on wrong subsidiary/employee, another than unverified status. Accepts end_price and assigned(both are optional), but should result in valid end_price.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
order_ids |
path | string | No |
Request body
Schema of the request body
{
"anyOf": [
{
"$ref": "#/components/schemas/OrderUpdateModel"
},
{
"type": "null"
}
],
"title": "Order"
}
Response 200 OK
{
"raised_ids": {}
}
Schema of the response body
{
"properties": {
"raised_ids": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Raised Ids"
}
},
"type": "object",
"required": [
"raised_ids"
],
"title": "MultiselectError"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
PUT /orders/{order_id}/to-unverified
Draw Up Order
Description
Restricted carrier by organization_id, by confirmation_end_time, by id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
order_id |
path | string | No |
Request body
{
"auction_end_time": null,
"stops": null,
"peculiarities": null,
"cargo_type": null,
"truck_body": null,
"client_price": null,
"start_price": null,
"end_price": null,
"currency": null,
"currency_caption": null,
"vat_type": null,
"rate_step": null,
"status": null,
"note": null,
"external": null,
"client": null,
"assigned": null,
"carrier": null,
"driver": null,
"truck": null,
"trailer": null,
"documents": null,
"cancel_reason": null,
"etag": null
}
Schema of the request body
{
"properties": {
"auction_end_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Auction End Time"
},
"stops": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/StopModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Stops"
},
"peculiarities": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"title": "Peculiarities"
},
"cargo_type": {
"anyOf": [
{
"type": "string",
"maxLength": 2048
},
{
"type": "null"
}
],
"title": "Cargo Type"
},
"truck_body": {
"anyOf": [
{
"$ref": "#/components/schemas/BodySettingsModel"
},
{
"type": "null"
}
]
},
"client_price": {
"anyOf": [
{
"type": "integer",
"minimum": 0.0
},
{
"type": "null"
}
],
"title": "Client Price"
},
"start_price": {
"anyOf": [
{
"type": "integer",
"exclusiveMaximum": 100000000.0,
"exclusiveMinimum": 0.0
},
{
"type": "null"
}
],
"title": "Start Price"
},
"end_price": {
"anyOf": [
{
"type": "integer",
"exclusiveMaximum": 100000000.0,
"exclusiveMinimum": 0.0
},
{
"type": "null"
}
],
"title": "End Price"
},
"currency": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency"
},
"currency_caption": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency Caption"
},
"vat_type": {
"anyOf": [
{
"$ref": "#/components/schemas/VATType"
},
{
"type": "null"
}
]
},
"rate_step": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Rate Step"
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderStatus"
},
{
"type": "null"
}
]
},
"note": {
"anyOf": [
{
"type": "string",
"maxLength": 8192
},
{
"type": "null"
}
],
"title": "Note"
},
"external": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderExternalData"
},
{
"type": "null"
}
]
},
"client": {
"anyOf": [
{
"$ref": "#/components/schemas/ClientCreateModel"
},
{
"$ref": "#/components/schemas/InsertByOIDModel"
},
{
"type": "null"
}
],
"title": "Client"
},
"assigned": {
"anyOf": [
{
"$ref": "#/components/schemas/AssignedCreateModel"
},
{
"type": "null"
}
]
},
"carrier": {
"anyOf": [
{
"$ref": "#/components/schemas/InsertByOIDModel"
},
{
"type": "null"
}
]
},
"driver": {
"anyOf": [
{
"$ref": "#/components/schemas/InsertByOIDModel"
},
{
"type": "null"
}
]
},
"truck": {
"anyOf": [
{
"$ref": "#/components/schemas/InsertByOIDModel"
},
{
"type": "null"
}
]
},
"trailer": {
"anyOf": [
{
"$ref": "#/components/schemas/InsertByOIDModel"
},
{
"type": "null"
}
]
},
"documents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/DocumentCreateModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Documents"
},
"cancel_reason": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"title": "Cancel Reason"
},
"etag": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Etag"
}
},
"type": "object",
"title": "ConfirmedOrderUpdateModel"
}
Response 200 OK
{
"id": "string",
"auction_end_time": null,
"stops": null,
"peculiarities": null,
"cargo_type": null,
"truck_body": null,
"client_price": null,
"start_price": null,
"end_price": null,
"currency": null,
"currency_caption": null,
"vat_type": null,
"rate_step": null,
"status": null,
"note": null,
"external": null,
"client": null,
"assigned": null,
"carrier": null,
"driver": null,
"truck": null,
"trailer": null,
"documents": null,
"cancel_reason": null,
"etag": null,
"completed_stages": null,
"created_at": null,
"your_bid": null,
"best_bid": null,
"confirmation_end_time": null,
"reservation_end_time": null,
"short_id": null,
"deleted_at": null,
"current_stage": null,
"document_draft": null,
"start_price_km": null,
"end_price_km": null,
"route_km": null,
"text_search": null,
"updated": null
}
Schema of the response body
{
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"auction_end_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Auction End Time"
},
"stops": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/StopModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Stops"
},
"peculiarities": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"title": "Peculiarities"
},
"cargo_type": {
"anyOf": [
{
"type": "string",
"maxLength": 2048
},
{
"type": "null"
}
],
"title": "Cargo Type"
},
"truck_body": {
"anyOf": [
{
"$ref": "#/components/schemas/BodySettingsModel"
},
{
"type": "null"
}
]
},
"client_price": {
"anyOf": [
{
"type": "integer",
"minimum": 0.0
},
{
"type": "null"
}
],
"title": "Client Price"
},
"start_price": {
"anyOf": [
{
"type": "integer",
"exclusiveMaximum": 100000000.0,
"exclusiveMinimum": 0.0
},
{
"type": "null"
}
],
"title": "Start Price"
},
"end_price": {
"anyOf": [
{
"type": "integer",
"exclusiveMaximum": 100000000.0,
"exclusiveMinimum": 0.0
},
{
"type": "null"
}
],
"title": "End Price"
},
"currency": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency"
},
"currency_caption": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency Caption"
},
"vat_type": {
"anyOf": [
{
"$ref": "#/components/schemas/VATType"
},
{
"type": "null"
}
]
},
"rate_step": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Rate Step"
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderStatus"
},
{
"type": "null"
}
]
},
"note": {
"anyOf": [
{
"type": "string",
"maxLength": 8192
},
{
"type": "null"
}
],
"title": "Note"
},
"external": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderExternalData"
},
{
"type": "null"
}
]
},
"client": {
"anyOf": [
{
"$ref": "#/components/schemas/ClientDBModel"
},
{
"type": "null"
}
]
},
"assigned": {
"anyOf": [
{
"$ref": "#/components/schemas/AssignedModel"
},
{
"type": "null"
}
]
},
"carrier": {
"anyOf": [
{
"$ref": "#/components/schemas/OrganizationDBModel"
},
{
"type": "null"
}
]
},
"driver": {
"anyOf": [
{
"$ref": "#/components/schemas/DriverDBModel"
},
{
"type": "null"
}
]
},
"truck": {
"anyOf": [
{
"$ref": "#/components/schemas/TruckDBModel"
},
{
"type": "null"
}
]
},
"trailer": {
"anyOf": [
{
"$ref": "#/components/schemas/TrailerDBModel"
},
{
"type": "null"
}
]
},
"documents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/DocumentDBModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Documents"
},
"cancel_reason": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"title": "Cancel Reason"
},
"etag": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Etag"
},
"completed_stages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/OrderStageModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Completed Stages"
},
"created_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At"
},
"your_bid": {
"anyOf": [
{
"$ref": "#/components/schemas/BidDBModel"
},
{
"type": "null"
}
]
},
"best_bid": {
"anyOf": [
{
"$ref": "#/components/schemas/BidDBModel"
},
{
"type": "null"
}
]
},
"confirmation_end_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Confirmation End Time"
},
"reservation_end_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Reservation End Time"
},
"short_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Short Id"
},
"deleted_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Deleted At"
},
"current_stage": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderStageModel"
},
{
"type": "null"
}
]
},
"document_draft": {
"anyOf": [
{
"$ref": "#/components/schemas/DocumentDBModel"
},
{
"type": "null"
}
]
},
"start_price_km": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Start Price Km"
},
"end_price_km": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "End Price Km"
},
"route_km": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Route Km"
},
"text_search": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Text Search"
},
"updated": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/UpdateMetadata"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Updated"
}
},
"type": "object",
"title": "OrderDBModel"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 404 Not Found
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
PUT /orders/{order_ids}/to-reserved
Order Through Auction
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
order_ids |
path | string | No |
Request body
Schema of the request body
{
"anyOf": [
{
"$ref": "#/components/schemas/OrderUpdateModel"
},
{
"type": "null"
}
],
"title": "Order"
}
Response 200 OK
{
"raised_ids": {}
}
Schema of the response body
{
"properties": {
"raised_ids": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Raised Ids"
}
},
"type": "object",
"required": [
"raised_ids"
],
"title": "MultiselectError"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 404 Not Found
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 406 Not Acceptable
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
exchange
GET /exchange-orders/xlsx
Excel Export Exchange
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
assignment |
query | string | No | ||
limit |
query | integer | 200 | No | |
projection |
query | string | No | ||
search |
query | string | No | ||
skip |
query | integer | 0 | No | |
sort |
query | string | No | ||
where |
query | string | No |
Response 200 OK
Schema of the response body
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
PUT /exchange-orders/{order_ids}/to-buffer
Put Order To Buffer
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
order_ids |
path | string | No |
Request body
Schema of the request body
{
"anyOf": [
{
"$ref": "#/components/schemas/OrderUpdateModel"
},
{
"type": "null"
}
],
"title": "Order"
}
Response 200 OK
{
"raised_ids": {}
}
Schema of the response body
{
"properties": {
"raised_ids": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Raised Ids"
}
},
"type": "object",
"required": [
"raised_ids"
],
"title": "MultiselectError"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 404 Not Found
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
PATCH /exchange-orders/{order_id}
Update Order
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
order_id |
path | string | No |
Request body
{
"auction_end_time": null,
"stops": null,
"peculiarities": null,
"cargo_type": null,
"truck_body": null,
"client_price": null,
"start_price": null,
"end_price": null,
"currency": null,
"currency_caption": null,
"vat_type": null,
"rate_step": null,
"status": null,
"note": null,
"external": null,
"client": null,
"assigned": null,
"carrier": null,
"driver": null,
"truck": null,
"trailer": null,
"documents": null,
"cancel_reason": null,
"etag": null
}
Schema of the request body
{
"properties": {
"auction_end_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Auction End Time"
},
"stops": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/StopModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Stops"
},
"peculiarities": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"title": "Peculiarities"
},
"cargo_type": {
"anyOf": [
{
"type": "string",
"maxLength": 2048
},
{
"type": "null"
}
],
"title": "Cargo Type"
},
"truck_body": {
"anyOf": [
{
"$ref": "#/components/schemas/BodySettingsModel"
},
{
"type": "null"
}
]
},
"client_price": {
"anyOf": [
{
"type": "integer",
"minimum": 0.0
},
{
"type": "null"
}
],
"title": "Client Price"
},
"start_price": {
"anyOf": [
{
"type": "integer",
"exclusiveMaximum": 100000000.0,
"exclusiveMinimum": 0.0
},
{
"type": "null"
}
],
"title": "Start Price"
},
"end_price": {
"anyOf": [
{
"type": "integer",
"exclusiveMaximum": 100000000.0,
"exclusiveMinimum": 0.0
},
{
"type": "null"
}
],
"title": "End Price"
},
"currency": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency"
},
"currency_caption": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency Caption"
},
"vat_type": {
"anyOf": [
{
"$ref": "#/components/schemas/VATType"
},
{
"type": "null"
}
]
},
"rate_step": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Rate Step"
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderStatus"
},
{
"type": "null"
}
]
},
"note": {
"anyOf": [
{
"type": "string",
"maxLength": 8192
},
{
"type": "null"
}
],
"title": "Note"
},
"external": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderExternalData"
},
{
"type": "null"
}
]
},
"client": {
"anyOf": [
{
"$ref": "#/components/schemas/ClientCreateModel"
},
{
"$ref": "#/components/schemas/InsertByOIDModel"
},
{
"type": "null"
}
],
"title": "Client"
},
"assigned": {
"anyOf": [
{
"$ref": "#/components/schemas/AssignedCreateModel"
},
{
"type": "null"
}
]
},
"carrier": {
"anyOf": [
{
"$ref": "#/components/schemas/InsertByOIDModel"
},
{
"type": "null"
}
]
},
"driver": {
"anyOf": [
{
"$ref": "#/components/schemas/InsertByOIDModel"
},
{
"type": "null"
}
]
},
"truck": {
"anyOf": [
{
"$ref": "#/components/schemas/InsertByOIDModel"
},
{
"type": "null"
}
]
},
"trailer": {
"anyOf": [
{
"$ref": "#/components/schemas/InsertByOIDModel"
},
{
"type": "null"
}
]
},
"documents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/InsertByOIDModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Documents"
},
"cancel_reason": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"title": "Cancel Reason"
},
"etag": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Etag"
}
},
"type": "object",
"title": "ExchangeOrderUpdateModel"
}
Response 200 OK
{
"id": "string",
"auction_end_time": null,
"stops": null,
"peculiarities": null,
"cargo_type": null,
"truck_body": null,
"client_price": null,
"start_price": null,
"end_price": null,
"currency": null,
"currency_caption": null,
"vat_type": null,
"rate_step": null,
"status": null,
"note": null,
"external": null,
"client": null,
"assigned": null,
"carrier": null,
"driver": null,
"truck": null,
"trailer": null,
"documents": null,
"cancel_reason": null,
"etag": null,
"completed_stages": null,
"created_at": null,
"your_bid": null,
"best_bid": null,
"confirmation_end_time": null,
"reservation_end_time": null,
"short_id": null,
"deleted_at": null,
"current_stage": null,
"document_draft": null,
"start_price_km": null,
"end_price_km": null,
"route_km": null,
"text_search": null,
"updated": null
}
Schema of the response body
{
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"auction_end_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Auction End Time"
},
"stops": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/StopModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Stops"
},
"peculiarities": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"title": "Peculiarities"
},
"cargo_type": {
"anyOf": [
{
"type": "string",
"maxLength": 2048
},
{
"type": "null"
}
],
"title": "Cargo Type"
},
"truck_body": {
"anyOf": [
{
"$ref": "#/components/schemas/BodySettingsModel"
},
{
"type": "null"
}
]
},
"client_price": {
"anyOf": [
{
"type": "integer",
"minimum": 0.0
},
{
"type": "null"
}
],
"title": "Client Price"
},
"start_price": {
"anyOf": [
{
"type": "integer",
"exclusiveMaximum": 100000000.0,
"exclusiveMinimum": 0.0
},
{
"type": "null"
}
],
"title": "Start Price"
},
"end_price": {
"anyOf": [
{
"type": "integer",
"exclusiveMaximum": 100000000.0,
"exclusiveMinimum": 0.0
},
{
"type": "null"
}
],
"title": "End Price"
},
"currency": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency"
},
"currency_caption": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency Caption"
},
"vat_type": {
"anyOf": [
{
"$ref": "#/components/schemas/VATType"
},
{
"type": "null"
}
]
},
"rate_step": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Rate Step"
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderStatus"
},
{
"type": "null"
}
]
},
"note": {
"anyOf": [
{
"type": "string",
"maxLength": 8192
},
{
"type": "null"
}
],
"title": "Note"
},
"external": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderExternalData"
},
{
"type": "null"
}
]
},
"client": {
"anyOf": [
{
"$ref": "#/components/schemas/ClientDBModel"
},
{
"type": "null"
}
]
},
"assigned": {
"anyOf": [
{
"$ref": "#/components/schemas/AssignedModel"
},
{
"type": "null"
}
]
},
"carrier": {
"anyOf": [
{
"$ref": "#/components/schemas/OrganizationDBModel"
},
{
"type": "null"
}
]
},
"driver": {
"anyOf": [
{
"$ref": "#/components/schemas/DriverDBModel"
},
{
"type": "null"
}
]
},
"truck": {
"anyOf": [
{
"$ref": "#/components/schemas/TruckDBModel"
},
{
"type": "null"
}
]
},
"trailer": {
"anyOf": [
{
"$ref": "#/components/schemas/TrailerDBModel"
},
{
"type": "null"
}
]
},
"documents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/DocumentDBModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Documents"
},
"cancel_reason": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"title": "Cancel Reason"
},
"etag": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Etag"
},
"completed_stages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/OrderStageModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Completed Stages"
},
"created_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At"
},
"your_bid": {
"anyOf": [
{
"$ref": "#/components/schemas/BidDBModel"
},
{
"type": "null"
}
]
},
"best_bid": {
"anyOf": [
{
"$ref": "#/components/schemas/BidDBModel"
},
{
"type": "null"
}
]
},
"confirmation_end_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Confirmation End Time"
},
"reservation_end_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Reservation End Time"
},
"short_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Short Id"
},
"deleted_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Deleted At"
},
"current_stage": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderStageModel"
},
{
"type": "null"
}
]
},
"document_draft": {
"anyOf": [
{
"$ref": "#/components/schemas/DocumentDBModel"
},
{
"type": "null"
}
]
},
"start_price_km": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Start Price Km"
},
"end_price_km": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "End Price Km"
},
"route_km": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Route Km"
},
"text_search": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Text Search"
},
"updated": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/UpdateMetadata"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Updated"
}
},
"type": "object",
"title": "OrderDBModel"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 404 Not Found
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /exchange-orders/{order_id}
Get Exchange Order By Id
Description
For any status starting with 'exchange' in exchange collection
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
order_id |
path | string | No | ||
projection |
query | string | No |
Response 200 OK
{
"id": "string",
"auction_end_time": null,
"stops": null,
"peculiarities": null,
"cargo_type": null,
"truck_body": null,
"client_price": null,
"start_price": null,
"end_price": null,
"currency": null,
"currency_caption": null,
"vat_type": null,
"rate_step": null,
"status": null,
"note": null,
"external": null,
"client": null,
"assigned": null,
"carrier": null,
"driver": null,
"truck": null,
"trailer": null,
"documents": null,
"cancel_reason": null,
"etag": null,
"completed_stages": null,
"created_at": null,
"your_bid": null,
"best_bid": null,
"confirmation_end_time": null,
"reservation_end_time": null,
"short_id": null,
"deleted_at": null,
"current_stage": null,
"document_draft": null,
"start_price_km": null,
"end_price_km": null,
"route_km": null,
"text_search": null,
"updated": null
}
Schema of the response body
{
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"auction_end_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Auction End Time"
},
"stops": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/StopModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Stops"
},
"peculiarities": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"title": "Peculiarities"
},
"cargo_type": {
"anyOf": [
{
"type": "string",
"maxLength": 2048
},
{
"type": "null"
}
],
"title": "Cargo Type"
},
"truck_body": {
"anyOf": [
{
"$ref": "#/components/schemas/BodySettingsModel"
},
{
"type": "null"
}
]
},
"client_price": {
"anyOf": [
{
"type": "integer",
"minimum": 0.0
},
{
"type": "null"
}
],
"title": "Client Price"
},
"start_price": {
"anyOf": [
{
"type": "integer",
"exclusiveMaximum": 100000000.0,
"exclusiveMinimum": 0.0
},
{
"type": "null"
}
],
"title": "Start Price"
},
"end_price": {
"anyOf": [
{
"type": "integer",
"exclusiveMaximum": 100000000.0,
"exclusiveMinimum": 0.0
},
{
"type": "null"
}
],
"title": "End Price"
},
"currency": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency"
},
"currency_caption": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency Caption"
},
"vat_type": {
"anyOf": [
{
"$ref": "#/components/schemas/VATType"
},
{
"type": "null"
}
]
},
"rate_step": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Rate Step"
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderStatus"
},
{
"type": "null"
}
]
},
"note": {
"anyOf": [
{
"type": "string",
"maxLength": 8192
},
{
"type": "null"
}
],
"title": "Note"
},
"external": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderExternalData"
},
{
"type": "null"
}
]
},
"client": {
"anyOf": [
{
"$ref": "#/components/schemas/ClientDBModel"
},
{
"type": "null"
}
]
},
"assigned": {
"anyOf": [
{
"$ref": "#/components/schemas/AssignedModel"
},
{
"type": "null"
}
]
},
"carrier": {
"anyOf": [
{
"$ref": "#/components/schemas/OrganizationDBModel"
},
{
"type": "null"
}
]
},
"driver": {
"anyOf": [
{
"$ref": "#/components/schemas/DriverDBModel"
},
{
"type": "null"
}
]
},
"truck": {
"anyOf": [
{
"$ref": "#/components/schemas/TruckDBModel"
},
{
"type": "null"
}
]
},
"trailer": {
"anyOf": [
{
"$ref": "#/components/schemas/TrailerDBModel"
},
{
"type": "null"
}
]
},
"documents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/DocumentDBModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Documents"
},
"cancel_reason": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"title": "Cancel Reason"
},
"etag": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Etag"
},
"completed_stages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/OrderStageModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Completed Stages"
},
"created_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At"
},
"your_bid": {
"anyOf": [
{
"$ref": "#/components/schemas/BidDBModel"
},
{
"type": "null"
}
]
},
"best_bid": {
"anyOf": [
{
"$ref": "#/components/schemas/BidDBModel"
},
{
"type": "null"
}
]
},
"confirmation_end_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Confirmation End Time"
},
"reservation_end_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Reservation End Time"
},
"short_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Short Id"
},
"deleted_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Deleted At"
},
"current_stage": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderStageModel"
},
{
"type": "null"
}
]
},
"document_draft": {
"anyOf": [
{
"$ref": "#/components/schemas/DocumentDBModel"
},
{
"type": "null"
}
]
},
"start_price_km": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Start Price Km"
},
"end_price_km": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "End Price Km"
},
"route_km": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Route Km"
},
"text_search": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Text Search"
},
"updated": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/UpdateMetadata"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Updated"
}
},
"type": "object",
"title": "OrderDBModel"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 404 Not Found
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
PUT /exchange-orders/{order_ids}/to-trash
Remove Order From Exchange
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
order_ids |
path | string | No |
Response 200 OK
{
"raised_ids": {}
}
Schema of the response body
{
"properties": {
"raised_ids": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Raised Ids"
}
},
"type": "object",
"required": [
"raised_ids"
],
"title": "MultiselectError"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 204 No Content
Response 404 Not Found
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /exchange-orders
Get Exchange
Description
For any status starting with 'exchange' for CompLogistician
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
assignment |
query | string | No | ||
limit |
query | integer | 200 | No | |
projection |
query | string | No | ||
search |
query | string | No | ||
skip |
query | integer | 0 | No | |
sort |
query | string | No | ||
where |
query | string | No |
Response 200 OK
{
"items": [
{
"id": "string",
"auction_end_time": null,
"stops": null,
"peculiarities": null,
"cargo_type": null,
"truck_body": null,
"client_price": null,
"start_price": null,
"end_price": null,
"currency": null,
"currency_caption": null,
"vat_type": null,
"rate_step": null,
"status": null,
"note": null,
"external": null,
"client": null,
"assigned": null,
"carrier": null,
"driver": null,
"truck": null,
"trailer": null,
"documents": null,
"cancel_reason": null,
"etag": null,
"completed_stages": null,
"created_at": null,
"your_bid": null,
"best_bid": null,
"confirmation_end_time": null,
"reservation_end_time": null,
"short_id": null,
"deleted_at": null,
"current_stage": null,
"document_draft": null,
"start_price_km": null,
"end_price_km": null,
"route_km": null,
"text_search": null,
"updated": null
}
],
"total": 0
}
Schema of the response body
{
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/OrderDBModel"
},
"type": "array",
"title": "Items"
},
"total": {
"type": "integer",
"title": "Total"
}
},
"type": "object",
"required": [
"items",
"total"
],
"title": "GenericGetListResponse[OrderDBModel]"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /exchange-orders/my-bids
Get Exchange Bids
Description
For any status starting with 'exchange' for CompLogistician
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
assignment |
query | string | No | ||
limit |
query | integer | 200 | No | |
projection |
query | string | No | ||
search |
query | string | No | ||
skip |
query | integer | 0 | No | |
sort |
query | string | No | ||
where |
query | string | No |
Response 200 OK
{
"items": [
{
"id": "string",
"auction_end_time": null,
"stops": null,
"peculiarities": null,
"cargo_type": null,
"truck_body": null,
"client_price": null,
"start_price": null,
"end_price": null,
"currency": null,
"currency_caption": null,
"vat_type": null,
"rate_step": null,
"status": null,
"note": null,
"external": null,
"client": null,
"assigned": null,
"carrier": null,
"driver": null,
"truck": null,
"trailer": null,
"documents": null,
"cancel_reason": null,
"etag": null,
"completed_stages": null,
"created_at": null,
"your_bid": null,
"best_bid": null,
"confirmation_end_time": null,
"reservation_end_time": null,
"short_id": null,
"deleted_at": null,
"current_stage": null,
"document_draft": null,
"start_price_km": null,
"end_price_km": null,
"route_km": null,
"text_search": null,
"updated": null
}
],
"total": 0
}
Schema of the response body
{
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/OrderDBModel"
},
"type": "array",
"title": "Items"
},
"total": {
"type": "integer",
"title": "Total"
}
},
"type": "object",
"required": [
"items",
"total"
],
"title": "GenericGetListResponse[OrderDBModel]"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
PUT /exchange-orders/{order_ids}/to-reserved
Order Through Auction
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
order_ids |
path | string | No |
Request body
Schema of the request body
{
"anyOf": [
{
"$ref": "#/components/schemas/OrderUpdateModel"
},
{
"type": "null"
}
],
"title": "Order"
}
Response 200 OK
{
"raised_ids": {}
}
Schema of the response body
{
"properties": {
"raised_ids": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Raised Ids"
}
},
"type": "object",
"required": [
"raised_ids"
],
"title": "MultiselectError"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 404 Not Found
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 406 Not Acceptable
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
PUT /exchange-orders/{order_id}/bid
Bid For Order
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
order_id |
path | string | No |
Request body
{
"value": 0
}
Schema of the request body
{
"properties": {
"value": {
"type": "integer",
"minimum": 1.0,
"title": "Value"
}
},
"type": "object",
"required": [
"value"
],
"title": "BidCreateModel"
}
Response 201 Created
{
"id": "string",
"value": null,
"client_id": "string",
"order_id": "string",
"owner": null,
"created_at": null,
"carrier": null,
"text_search": null
}
Schema of the response body
{
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"value": {
"anyOf": [
{
"type": "integer",
"minimum": 1.0
},
{
"type": "null"
}
],
"title": "Value"
},
"client_id": {
"type": "string",
"title": "Client Id"
},
"order_id": {
"type": "string",
"title": "Order Id"
},
"owner": {
"anyOf": [
{
"$ref": "#/components/schemas/SotransUserDBModel"
},
{
"type": "null"
}
]
},
"created_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At"
},
"carrier": {
"anyOf": [
{
"$ref": "#/components/schemas/OrganizationDBModel"
},
{
"type": "null"
}
]
},
"text_search": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Text Search"
}
},
"type": "object",
"title": "BidDBModel"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 400 Bad Request
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 404 Not Found
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 406 Not Acceptable
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
PUT /exchange-orders/{order_ids}/to-confirmed
Confirm Order
Description
Accepts carrier(optional) and assigned(optional).
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
order_ids |
path | string | No |
Request body
Schema of the request body
{
"anyOf": [
{
"$ref": "#/components/schemas/OrderUpdateModel"
},
{
"type": "null"
}
],
"title": "Order"
}
Response 200 OK
{
"raised_ids": {}
}
Schema of the response body
{
"properties": {
"raised_ids": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Raised Ids"
}
},
"type": "object",
"required": [
"raised_ids"
],
"title": "MultiselectError"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /exchange-orders/{order_id}/is-admitted
Get Exchange Order By Id With Verification
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
order_id |
path | string | No | ||
projection |
query | string | No |
Response 200 OK
{
"id": "string",
"auction_end_time": null,
"stops": null,
"peculiarities": null,
"cargo_type": null,
"truck_body": null,
"client_price": null,
"start_price": null,
"end_price": null,
"currency": null,
"currency_caption": null,
"vat_type": null,
"rate_step": null,
"status": null,
"note": null,
"external": null,
"client": null,
"assigned": null,
"carrier": null,
"driver": null,
"truck": null,
"trailer": null,
"documents": null,
"cancel_reason": null,
"etag": null,
"completed_stages": null,
"created_at": null,
"your_bid": null,
"best_bid": null,
"confirmation_end_time": null,
"reservation_end_time": null,
"short_id": null,
"deleted_at": null,
"current_stage": null,
"document_draft": null,
"start_price_km": null,
"end_price_km": null,
"route_km": null,
"text_search": null,
"updated": null,
"resource_check_passing": null
}
Schema of the response body
{
"properties": {
"id": {
"type": "string",
"title": "Id",
"default": "id"
},
"auction_end_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Auction End Time",
"default": "auction_end_time"
},
"stops": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/StopModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Stops",
"default": [
"stops"
]
},
"peculiarities": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Peculiarities",
"default": "peculiarities"
},
"cargo_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cargo Type",
"default": "cargo_type"
},
"truck_body": {
"anyOf": [
{
"$ref": "#/components/schemas/BodySettingsModel"
},
{
"type": "null"
}
],
"default": "truck_body"
},
"client_price": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Client Price",
"default": "client_price"
},
"start_price": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Start Price",
"default": "start_price"
},
"end_price": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "End Price",
"default": "end_price"
},
"currency": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"default": "currency"
},
"currency_caption": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency Caption",
"default": "currency_caption"
},
"vat_type": {
"anyOf": [
{
"$ref": "#/components/schemas/VATType"
},
{
"type": "null"
}
],
"default": "vat_type"
},
"rate_step": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Rate Step",
"default": "rate_step"
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderStatus"
},
{
"type": "null"
}
],
"default": "status"
},
"note": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Note",
"default": "note"
},
"external": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderExternalData"
},
{
"type": "null"
}
],
"default": "external"
},
"client": {
"anyOf": [
{
"$ref": "#/components/schemas/ClientDBModel"
},
{
"type": "null"
}
],
"default": "client"
},
"assigned": {
"anyOf": [
{
"$ref": "#/components/schemas/AssignedModel"
},
{
"type": "null"
}
],
"default": "assigned"
},
"carrier": {
"anyOf": [
{
"$ref": "#/components/schemas/OrganizationDBModel"
},
{
"type": "null"
}
],
"default": "carrier"
},
"driver": {
"anyOf": [
{
"$ref": "#/components/schemas/DriverDBModel"
},
{
"type": "null"
}
],
"default": "driver"
},
"truck": {
"anyOf": [
{
"$ref": "#/components/schemas/TruckDBModel"
},
{
"type": "null"
}
],
"default": "truck"
},
"trailer": {
"anyOf": [
{
"$ref": "#/components/schemas/TrailerDBModel"
},
{
"type": "null"
}
],
"default": "trailer"
},
"documents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/DocumentDBModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Documents",
"default": [
"documents"
]
},
"cancel_reason": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cancel Reason",
"default": "cancel_reason"
},
"etag": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Etag",
"default": "etag"
},
"completed_stages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/OrderStageModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Completed Stages",
"default": [
"completed_stages"
]
},
"created_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At",
"default": "created_at"
},
"your_bid": {
"anyOf": [
{
"$ref": "#/components/schemas/BidDBModel"
},
{
"type": "null"
}
],
"default": "your_bid"
},
"best_bid": {
"anyOf": [
{
"$ref": "#/components/schemas/BidDBModel"
},
{
"type": "null"
}
],
"default": "best_bid"
},
"confirmation_end_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Confirmation End Time",
"default": "confirmation_end_time"
},
"reservation_end_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Reservation End Time",
"default": "reservation_end_time"
},
"short_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Short Id",
"default": "short_id"
},
"deleted_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Deleted At",
"default": "deleted_at"
},
"current_stage": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderStageModel"
},
{
"type": "null"
}
],
"default": "current_stage"
},
"document_draft": {
"anyOf": [
{
"$ref": "#/components/schemas/DocumentDBModel"
},
{
"type": "null"
}
],
"default": "document_draft"
},
"start_price_km": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Start Price Km",
"default": "start_price_km"
},
"end_price_km": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "End Price Km",
"default": "end_price_km"
},
"route_km": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Route Km",
"default": "route_km"
},
"text_search": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Text Search",
"default": "text_search"
},
"updated": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/UpdateMetadata"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Updated",
"default": [
"updated"
]
},
"resource_check_passing": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Resource Check Passing"
}
},
"type": "object",
"title": "ResourceCheckOrderDBModel"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 404 Not Found
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
PUT /exchange-orders/{order_ids}/to-appointment
Order To Appointment
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
order_ids |
path | string | No |
Request body
Schema of the request body
{
"anyOf": [
{
"$ref": "#/components/schemas/OrderUpdateModel"
},
{
"type": "null"
}
],
"title": "Order"
}
Response 200 OK
{
"raised_ids": {}
}
Schema of the response body
{
"properties": {
"raised_ids": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Raised Ids"
}
},
"type": "object",
"required": [
"raised_ids"
],
"title": "MultiselectError"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
bids
DELETE /bids/{bid_id}
Take Bid Away
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
bid_id |
path | string | No |
Response 204 No Content
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 404 Not Found
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 406 Not Acceptable
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /bids/{bid_id}
Get Bid By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
bid_id |
path | string | No | ||
projection |
query | string | No |
Response 200 OK
{
"id": "string",
"value": null,
"client_id": "string",
"order_id": "string",
"owner": null,
"created_at": null,
"carrier": null,
"text_search": null
}
Schema of the response body
{
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"value": {
"anyOf": [
{
"type": "integer",
"minimum": 1.0
},
{
"type": "null"
}
],
"title": "Value"
},
"client_id": {
"type": "string",
"title": "Client Id"
},
"order_id": {
"type": "string",
"title": "Order Id"
},
"owner": {
"anyOf": [
{
"$ref": "#/components/schemas/SotransUserDBModel"
},
{
"type": "null"
}
]
},
"created_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At"
},
"carrier": {
"anyOf": [
{
"$ref": "#/components/schemas/OrganizationDBModel"
},
{
"type": "null"
}
]
},
"text_search": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Text Search"
}
},
"type": "object",
"title": "BidDBModel"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 404 Not Found
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /bids
Get Bids
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
assignment |
query | string | No | ||
limit |
query | integer | 200 | No | |
projection |
query | string | No | ||
search |
query | string | No | ||
skip |
query | integer | 0 | No | |
sort |
query | string | No | ||
where |
query | string | No |
Response 200 OK
{
"items": [
{
"id": "string",
"value": null,
"client_id": "string",
"order_id": "string",
"owner": null,
"created_at": null,
"carrier": null,
"text_search": null
}
],
"total": 0
}
Schema of the response body
{
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/BidDBModel"
},
"type": "array",
"title": "Items"
},
"total": {
"type": "integer",
"title": "Total"
}
},
"type": "object",
"required": [
"items",
"total"
],
"title": "GenericGetListResponse[BidDBModel]"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
confirmed
PUT /confirmed-orders/{order_ids}/to-exchange
Put Order To Auction
Description
Accepts start_price(required), assigned(optional) and auction_end_time(optional).
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
order_ids |
path | string | No |
Request body
{
"auction_end_time": null,
"stops": null,
"peculiarities": null,
"cargo_type": null,
"truck_body": null,
"client_price": null,
"start_price": null,
"end_price": null,
"currency": null,
"currency_caption": null,
"vat_type": null,
"rate_step": null,
"status": null,
"note": null,
"external": null,
"client": null,
"assigned": null,
"carrier": null,
"driver": null,
"truck": null,
"trailer": null,
"documents": null,
"cancel_reason": null,
"etag": null
}
Schema of the request body
{
"properties": {
"auction_end_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Auction End Time"
},
"stops": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/StopModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Stops"
},
"peculiarities": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"title": "Peculiarities"
},
"cargo_type": {
"anyOf": [
{
"type": "string",
"maxLength": 2048
},
{
"type": "null"
}
],
"title": "Cargo Type"
},
"truck_body": {
"anyOf": [
{
"$ref": "#/components/schemas/BodySettingsModel"
},
{
"type": "null"
}
]
},
"client_price": {
"anyOf": [
{
"type": "integer",
"minimum": 0.0
},
{
"type": "null"
}
],
"title": "Client Price"
},
"start_price": {
"anyOf": [
{
"type": "integer",
"exclusiveMaximum": 100000000.0,
"exclusiveMinimum": 0.0
},
{
"type": "null"
}
],
"title": "Start Price"
},
"end_price": {
"anyOf": [
{
"type": "integer",
"exclusiveMaximum": 100000000.0,
"exclusiveMinimum": 0.0
},
{
"type": "null"
}
],
"title": "End Price"
},
"currency": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency"
},
"currency_caption": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency Caption"
},
"vat_type": {
"anyOf": [
{
"$ref": "#/components/schemas/VATType"
},
{
"type": "null"
}
]
},
"rate_step": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Rate Step"
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderStatus"
},
{
"type": "null"
}
]
},
"note": {
"anyOf": [
{
"type": "string",
"maxLength": 8192
},
{
"type": "null"
}
],
"title": "Note"
},
"external": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderExternalData"
},
{
"type": "null"
}
]
},
"client": {
"anyOf": [
{
"$ref": "#/components/schemas/ClientCreateModel"
},
{
"$ref": "#/components/schemas/InsertByOIDModel"
},
{
"type": "null"
}
],
"title": "Client"
},
"assigned": {
"anyOf": [
{
"$ref": "#/components/schemas/AssignedCreateModel"
},
{
"type": "null"
}
]
},
"carrier": {
"anyOf": [
{
"$ref": "#/components/schemas/InsertByOIDModel"
},
{
"type": "null"
}
]
},
"driver": {
"anyOf": [
{
"$ref": "#/components/schemas/InsertByOIDModel"
},
{
"type": "null"
}
]
},
"truck": {
"anyOf": [
{
"$ref": "#/components/schemas/InsertByOIDModel"
},
{
"type": "null"
}
]
},
"trailer": {
"anyOf": [
{
"$ref": "#/components/schemas/InsertByOIDModel"
},
{
"type": "null"
}
]
},
"documents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/InsertByOIDModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Documents"
},
"cancel_reason": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"title": "Cancel Reason"
},
"etag": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Etag"
}
},
"type": "object",
"title": "OrderUpdateModel"
}
Response 200 OK
{
"raised_ids": {}
}
Schema of the response body
{
"properties": {
"raised_ids": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Raised Ids"
}
},
"type": "object",
"required": [
"raised_ids"
],
"title": "MultiselectError"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
PUT /confirmed-orders/{order_ids}/to-active
Put Order To Active
Description
Throws Not Found on wrong subsidiary/employee, another than unverified status. Accepts end_price and assigned(both are optional).
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
order_ids |
path | string | No |
Request body
Schema of the request body
{
"anyOf": [
{
"$ref": "#/components/schemas/OrderUpdateModel"
},
{
"type": "null"
}
],
"title": "Order"
}
Response 200 OK
{
"raised_ids": {}
}
Schema of the response body
{
"properties": {
"raised_ids": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Raised Ids"
}
},
"type": "object",
"required": [
"raised_ids"
],
"title": "MultiselectError"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
PUT /confirmed-orders/{order_id}/to-unverified
Draw Up Order
Description
Restricted carrier by organization_id, by confirmation_end_time, by id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
order_id |
path | string | No |
Request body
{
"auction_end_time": null,
"stops": null,
"peculiarities": null,
"cargo_type": null,
"truck_body": null,
"client_price": null,
"start_price": null,
"end_price": null,
"currency": null,
"currency_caption": null,
"vat_type": null,
"rate_step": null,
"status": null,
"note": null,
"external": null,
"client": null,
"assigned": null,
"carrier": null,
"driver": null,
"truck": null,
"trailer": null,
"documents": null,
"cancel_reason": null,
"etag": null
}
Schema of the request body
{
"properties": {
"auction_end_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Auction End Time"
},
"stops": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/StopModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Stops"
},
"peculiarities": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"title": "Peculiarities"
},
"cargo_type": {
"anyOf": [
{
"type": "string",
"maxLength": 2048
},
{
"type": "null"
}
],
"title": "Cargo Type"
},
"truck_body": {
"anyOf": [
{
"$ref": "#/components/schemas/BodySettingsModel"
},
{
"type": "null"
}
]
},
"client_price": {
"anyOf": [
{
"type": "integer",
"minimum": 0.0
},
{
"type": "null"
}
],
"title": "Client Price"
},
"start_price": {
"anyOf": [
{
"type": "integer",
"exclusiveMaximum": 100000000.0,
"exclusiveMinimum": 0.0
},
{
"type": "null"
}
],
"title": "Start Price"
},
"end_price": {
"anyOf": [
{
"type": "integer",
"exclusiveMaximum": 100000000.0,
"exclusiveMinimum": 0.0
},
{
"type": "null"
}
],
"title": "End Price"
},
"currency": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency"
},
"currency_caption": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency Caption"
},
"vat_type": {
"anyOf": [
{
"$ref": "#/components/schemas/VATType"
},
{
"type": "null"
}
]
},
"rate_step": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Rate Step"
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderStatus"
},
{
"type": "null"
}
]
},
"note": {
"anyOf": [
{
"type": "string",
"maxLength": 8192
},
{
"type": "null"
}
],
"title": "Note"
},
"external": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderExternalData"
},
{
"type": "null"
}
]
},
"client": {
"anyOf": [
{
"$ref": "#/components/schemas/ClientCreateModel"
},
{
"$ref": "#/components/schemas/InsertByOIDModel"
},
{
"type": "null"
}
],
"title": "Client"
},
"assigned": {
"anyOf": [
{
"$ref": "#/components/schemas/AssignedCreateModel"
},
{
"type": "null"
}
]
},
"carrier": {
"anyOf": [
{
"$ref": "#/components/schemas/InsertByOIDModel"
},
{
"type": "null"
}
]
},
"driver": {
"anyOf": [
{
"$ref": "#/components/schemas/InsertByOIDModel"
},
{
"type": "null"
}
]
},
"truck": {
"anyOf": [
{
"$ref": "#/components/schemas/InsertByOIDModel"
},
{
"type": "null"
}
]
},
"trailer": {
"anyOf": [
{
"$ref": "#/components/schemas/InsertByOIDModel"
},
{
"type": "null"
}
]
},
"documents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/DocumentCreateModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Documents"
},
"cancel_reason": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"title": "Cancel Reason"
},
"etag": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Etag"
}
},
"type": "object",
"title": "ConfirmedOrderUpdateModel"
}
Response 200 OK
{
"id": "string",
"auction_end_time": null,
"stops": null,
"peculiarities": null,
"cargo_type": null,
"truck_body": null,
"client_price": null,
"start_price": null,
"end_price": null,
"currency": null,
"currency_caption": null,
"vat_type": null,
"rate_step": null,
"status": null,
"note": null,
"external": null,
"client": null,
"assigned": null,
"carrier": null,
"driver": null,
"truck": null,
"trailer": null,
"documents": null,
"cancel_reason": null,
"etag": null,
"completed_stages": null,
"created_at": null,
"your_bid": null,
"best_bid": null,
"confirmation_end_time": null,
"reservation_end_time": null,
"short_id": null,
"deleted_at": null,
"current_stage": null,
"document_draft": null,
"start_price_km": null,
"end_price_km": null,
"route_km": null,
"text_search": null,
"updated": null
}
Schema of the response body
{
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"auction_end_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Auction End Time"
},
"stops": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/StopModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Stops"
},
"peculiarities": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"title": "Peculiarities"
},
"cargo_type": {
"anyOf": [
{
"type": "string",
"maxLength": 2048
},
{
"type": "null"
}
],
"title": "Cargo Type"
},
"truck_body": {
"anyOf": [
{
"$ref": "#/components/schemas/BodySettingsModel"
},
{
"type": "null"
}
]
},
"client_price": {
"anyOf": [
{
"type": "integer",
"minimum": 0.0
},
{
"type": "null"
}
],
"title": "Client Price"
},
"start_price": {
"anyOf": [
{
"type": "integer",
"exclusiveMaximum": 100000000.0,
"exclusiveMinimum": 0.0
},
{
"type": "null"
}
],
"title": "Start Price"
},
"end_price": {
"anyOf": [
{
"type": "integer",
"exclusiveMaximum": 100000000.0,
"exclusiveMinimum": 0.0
},
{
"type": "null"
}
],
"title": "End Price"
},
"currency": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency"
},
"currency_caption": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency Caption"
},
"vat_type": {
"anyOf": [
{
"$ref": "#/components/schemas/VATType"
},
{
"type": "null"
}
]
},
"rate_step": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Rate Step"
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderStatus"
},
{
"type": "null"
}
]
},
"note": {
"anyOf": [
{
"type": "string",
"maxLength": 8192
},
{
"type": "null"
}
],
"title": "Note"
},
"external": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderExternalData"
},
{
"type": "null"
}
]
},
"client": {
"anyOf": [
{
"$ref": "#/components/schemas/ClientDBModel"
},
{
"type": "null"
}
]
},
"assigned": {
"anyOf": [
{
"$ref": "#/components/schemas/AssignedModel"
},
{
"type": "null"
}
]
},
"carrier": {
"anyOf": [
{
"$ref": "#/components/schemas/OrganizationDBModel"
},
{
"type": "null"
}
]
},
"driver": {
"anyOf": [
{
"$ref": "#/components/schemas/DriverDBModel"
},
{
"type": "null"
}
]
},
"truck": {
"anyOf": [
{
"$ref": "#/components/schemas/TruckDBModel"
},
{
"type": "null"
}
]
},
"trailer": {
"anyOf": [
{
"$ref": "#/components/schemas/TrailerDBModel"
},
{
"type": "null"
}
]
},
"documents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/DocumentDBModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Documents"
},
"cancel_reason": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"title": "Cancel Reason"
},
"etag": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Etag"
},
"completed_stages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/OrderStageModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Completed Stages"
},
"created_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At"
},
"your_bid": {
"anyOf": [
{
"$ref": "#/components/schemas/BidDBModel"
},
{
"type": "null"
}
]
},
"best_bid": {
"anyOf": [
{
"$ref": "#/components/schemas/BidDBModel"
},
{
"type": "null"
}
]
},
"confirmation_end_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Confirmation End Time"
},
"reservation_end_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Reservation End Time"
},
"short_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Short Id"
},
"deleted_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Deleted At"
},
"current_stage": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderStageModel"
},
{
"type": "null"
}
]
},
"document_draft": {
"anyOf": [
{
"$ref": "#/components/schemas/DocumentDBModel"
},
{
"type": "null"
}
]
},
"start_price_km": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Start Price Km"
},
"end_price_km": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "End Price Km"
},
"route_km": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Route Km"
},
"text_search": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Text Search"
},
"updated": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/UpdateMetadata"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Updated"
}
},
"type": "object",
"title": "OrderDBModel"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 404 Not Found
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /confirmed-orders
Get Confirmed Orders
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
assignment |
query | string | No | ||
limit |
query | integer | 200 | No | |
projection |
query | string | No | ||
search |
query | string | No | ||
skip |
query | integer | 0 | No | |
sort |
query | string | No | ||
where |
query | string | No |
Response 200 OK
{
"items": [
{
"id": "string",
"auction_end_time": null,
"stops": null,
"peculiarities": null,
"cargo_type": null,
"truck_body": null,
"client_price": null,
"start_price": null,
"end_price": null,
"currency": null,
"currency_caption": null,
"vat_type": null,
"rate_step": null,
"status": null,
"note": null,
"external": null,
"client": null,
"assigned": null,
"carrier": null,
"driver": null,
"truck": null,
"trailer": null,
"documents": null,
"cancel_reason": null,
"etag": null,
"completed_stages": null,
"created_at": null,
"your_bid": null,
"best_bid": null,
"confirmation_end_time": null,
"reservation_end_time": null,
"short_id": null,
"deleted_at": null,
"current_stage": null,
"document_draft": null,
"start_price_km": null,
"end_price_km": null,
"route_km": null,
"text_search": null,
"updated": null
}
],
"total": 0
}
Schema of the response body
{
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/OrderDBModel"
},
"type": "array",
"title": "Items"
},
"total": {
"type": "integer",
"title": "Total"
}
},
"type": "object",
"required": [
"items",
"total"
],
"title": "GenericGetListResponse[OrderDBModel]"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
PUT /confirmed-orders/{order_ids}/to-appointment
Confirmed To Appointment
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
order_ids |
path | string | No |
Request body
Schema of the request body
{
"anyOf": [
{
"$ref": "#/components/schemas/OrderUpdateModel"
},
{
"type": "null"
}
],
"title": "Order"
}
Response 200 OK
{
"raised_ids": {}
}
Schema of the response body
{
"properties": {
"raised_ids": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Raised Ids"
}
},
"type": "object",
"required": [
"raised_ids"
],
"title": "MultiselectError"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
POST /confirmed-orders/notify_winner
Notify Winner
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No |
Request body
{
"order_ids": [
"string"
]
}
Schema of the request body
{
"properties": {
"order_ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Order Ids"
}
},
"type": "object",
"required": [
"order_ids"
],
"title": "AucEndNotificationCall"
}
Response 200 OK
Schema of the response body
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /confirmed-orders/{order_id}
Get Confirmed By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
order_id |
path | string | No | ||
projection |
query | string | No |
Response 200 OK
{
"id": "string",
"auction_end_time": null,
"stops": null,
"peculiarities": null,
"cargo_type": null,
"truck_body": null,
"client_price": null,
"start_price": null,
"end_price": null,
"currency": null,
"currency_caption": null,
"vat_type": null,
"rate_step": null,
"status": null,
"note": null,
"external": null,
"client": null,
"assigned": null,
"carrier": null,
"driver": null,
"truck": null,
"trailer": null,
"documents": null,
"cancel_reason": null,
"etag": null,
"completed_stages": null,
"created_at": null,
"your_bid": null,
"best_bid": null,
"confirmation_end_time": null,
"reservation_end_time": null,
"short_id": null,
"deleted_at": null,
"current_stage": null,
"document_draft": null,
"start_price_km": null,
"end_price_km": null,
"route_km": null,
"text_search": null,
"updated": null
}
Schema of the response body
{
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"auction_end_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Auction End Time"
},
"stops": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/StopModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Stops"
},
"peculiarities": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"title": "Peculiarities"
},
"cargo_type": {
"anyOf": [
{
"type": "string",
"maxLength": 2048
},
{
"type": "null"
}
],
"title": "Cargo Type"
},
"truck_body": {
"anyOf": [
{
"$ref": "#/components/schemas/BodySettingsModel"
},
{
"type": "null"
}
]
},
"client_price": {
"anyOf": [
{
"type": "integer",
"minimum": 0.0
},
{
"type": "null"
}
],
"title": "Client Price"
},
"start_price": {
"anyOf": [
{
"type": "integer",
"exclusiveMaximum": 100000000.0,
"exclusiveMinimum": 0.0
},
{
"type": "null"
}
],
"title": "Start Price"
},
"end_price": {
"anyOf": [
{
"type": "integer",
"exclusiveMaximum": 100000000.0,
"exclusiveMinimum": 0.0
},
{
"type": "null"
}
],
"title": "End Price"
},
"currency": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency"
},
"currency_caption": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency Caption"
},
"vat_type": {
"anyOf": [
{
"$ref": "#/components/schemas/VATType"
},
{
"type": "null"
}
]
},
"rate_step": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Rate Step"
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderStatus"
},
{
"type": "null"
}
]
},
"note": {
"anyOf": [
{
"type": "string",
"maxLength": 8192
},
{
"type": "null"
}
],
"title": "Note"
},
"external": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderExternalData"
},
{
"type": "null"
}
]
},
"client": {
"anyOf": [
{
"$ref": "#/components/schemas/ClientDBModel"
},
{
"type": "null"
}
]
},
"assigned": {
"anyOf": [
{
"$ref": "#/components/schemas/AssignedModel"
},
{
"type": "null"
}
]
},
"carrier": {
"anyOf": [
{
"$ref": "#/components/schemas/OrganizationDBModel"
},
{
"type": "null"
}
]
},
"driver": {
"anyOf": [
{
"$ref": "#/components/schemas/DriverDBModel"
},
{
"type": "null"
}
]
},
"truck": {
"anyOf": [
{
"$ref": "#/components/schemas/TruckDBModel"
},
{
"type": "null"
}
]
},
"trailer": {
"anyOf": [
{
"$ref": "#/components/schemas/TrailerDBModel"
},
{
"type": "null"
}
]
},
"documents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/DocumentDBModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Documents"
},
"cancel_reason": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"title": "Cancel Reason"
},
"etag": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Etag"
},
"completed_stages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/OrderStageModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Completed Stages"
},
"created_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At"
},
"your_bid": {
"anyOf": [
{
"$ref": "#/components/schemas/BidDBModel"
},
{
"type": "null"
}
]
},
"best_bid": {
"anyOf": [
{
"$ref": "#/components/schemas/BidDBModel"
},
{
"type": "null"
}
]
},
"confirmation_end_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Confirmation End Time"
},
"reservation_end_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Reservation End Time"
},
"short_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Short Id"
},
"deleted_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Deleted At"
},
"current_stage": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderStageModel"
},
{
"type": "null"
}
]
},
"document_draft": {
"anyOf": [
{
"$ref": "#/components/schemas/DocumentDBModel"
},
{
"type": "null"
}
]
},
"start_price_km": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Start Price Km"
},
"end_price_km": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "End Price Km"
},
"route_km": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Route Km"
},
"text_search": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Text Search"
},
"updated": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/UpdateMetadata"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Updated"
}
},
"type": "object",
"title": "OrderDBModel"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 404 Not Found
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
external-orders
GET /external-orders
Get Orders Batch
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
resource_name |
query | string | No | ||
show_missing |
query | boolean | False | No |
Response 200 OK
[
{
"id": "string",
"auction_end_time": null,
"stops": null,
"peculiarities": null,
"cargo_type": null,
"truck_body": null,
"client_price": null,
"start_price": null,
"end_price": null,
"currency": null,
"currency_caption": null,
"vat_type": null,
"rate_step": null,
"status": null,
"note": null,
"external": null,
"client": null,
"assigned": null,
"carrier": null,
"driver": null,
"truck": null,
"trailer": null,
"documents": null,
"cancel_reason": null,
"etag": null,
"completed_stages": null,
"created_at": null,
"your_bid": null,
"best_bid": null,
"confirmation_end_time": null,
"reservation_end_time": null,
"short_id": null,
"deleted_at": null,
"current_stage": null,
"document_draft": null,
"start_price_km": null,
"end_price_km": null,
"route_km": null,
"text_search": null,
"updated": null
}
]
Schema of the response body
{
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderDBModel"
},
"title": "Response Get Orders Batch External Orders Get"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
POST /external-orders
Save Orders Batch
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No |
Request body
{
"items": [
{
"auction_end_time": null,
"stops": [
{
"index": null,
"datetime": null,
"address": null,
"stop_type": null,
"note": null
}
],
"peculiarities": null,
"cargo_type": null,
"truck_body": {
"body_type": null,
"loading_type": null,
"weight": null,
"volume": null
},
"client_price": 0,
"start_price": null,
"end_price": null,
"currency": "string",
"currency_caption": "string",
"vat_type": null,
"rate_step": 0,
"status": null,
"note": null,
"external": null,
"client": null,
"assigned": null,
"carrier": null,
"driver": null,
"truck": null,
"trailer": null,
"documents": null
}
]
}
Schema of the request body
{
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/OrderCreateModel"
},
"type": "array",
"title": "Items"
}
},
"type": "object",
"required": [
"items"
],
"title": "ScrapedOrdersCreateModel"
}
Response 201 Created
Schema of the response body
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
PATCH /external-orders
Patch Batch
Description
Updates by external_data->link.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No |
Request body
{
"items": [
{
"auction_end_time": null,
"stops": [
{
"index": null,
"datetime": null,
"address": null,
"stop_type": null,
"note": null
}
],
"peculiarities": null,
"cargo_type": null,
"truck_body": {
"body_type": null,
"loading_type": null,
"weight": null,
"volume": null
},
"client_price": 0,
"start_price": null,
"end_price": null,
"currency": "string",
"currency_caption": "string",
"vat_type": null,
"rate_step": 0,
"status": null,
"note": null,
"external": null,
"client": null,
"assigned": null,
"carrier": null,
"driver": null,
"truck": null,
"trailer": null,
"documents": null
}
]
}
Schema of the request body
{
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/OrderCreateModel"
},
"type": "array",
"title": "Items"
}
},
"type": "object",
"required": [
"items"
],
"title": "ScrapedOrdersCreateModel"
}
Response 200 OK
Schema of the response body
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
DELETE /external-orders
Delete Batch
Description
Updates by external_data->link.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No |
Request body
{
"items": [
{
"id": "string",
"auction_end_time": null,
"stops": null,
"peculiarities": null,
"cargo_type": null,
"truck_body": null,
"client_price": null,
"start_price": null,
"end_price": null,
"currency": null,
"currency_caption": null,
"vat_type": null,
"rate_step": null,
"status": null,
"note": null,
"external": null,
"client": null,
"assigned": null,
"carrier": null,
"driver": null,
"truck": null,
"trailer": null,
"documents": null,
"cancel_reason": null,
"etag": null,
"completed_stages": null,
"created_at": null,
"your_bid": null,
"best_bid": null,
"confirmation_end_time": null,
"reservation_end_time": null,
"short_id": null,
"deleted_at": null,
"current_stage": null,
"document_draft": null,
"start_price_km": null,
"end_price_km": null,
"route_km": null,
"text_search": null,
"updated": null
}
]
}
Schema of the request body
{
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/OrderDBModel"
},
"type": "array",
"title": "Items"
}
},
"type": "object",
"required": [
"items"
],
"title": "ScrapedOrdersModel"
}
Response 204 No Content
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
POST /external-orders/error
On Error
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No |
Request body
Schema of the request body
{
"type": "object",
"title": "Error"
}
Response 200 OK
Schema of the response body
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
suggestions
GET /suggestions/employees
Get Employees Suggestions
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
limit |
query | integer | 10 | No | |
minimal_role |
query | None | No | ||
search_query |
query | string | No | ||
skip |
query | integer | 0 | No |
Response 200 OK
[
{
"value": "string",
"label": "string"
}
]
Schema of the response body
{
"type": "array",
"items": {
"$ref": "#/components/schemas/SuggestionsResponseModel"
},
"title": "Response Get Employees Suggestions Suggestions Employees Get"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /suggestions/trucks
Get Trucks Suggestions
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
limit |
query | integer | 10 | No | |
search_query |
query | string | No | ||
skip |
query | integer | 0 | No |
Response 200 OK
[
{
"value": "string",
"label": "string"
}
]
Schema of the response body
{
"type": "array",
"items": {
"$ref": "#/components/schemas/SuggestionsResponseModel"
},
"title": "Response Get Trucks Suggestions Suggestions Trucks Get"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /suggestions/trailers
Get Trailers Suggestions
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
limit |
query | integer | 10 | No | |
search_query |
query | string | No | ||
skip |
query | integer | 0 | No |
Response 200 OK
[
{
"value": "string",
"label": "string"
}
]
Schema of the response body
{
"type": "array",
"items": {
"$ref": "#/components/schemas/SuggestionsResponseModel"
},
"title": "Response Get Trailers Suggestions Suggestions Trailers Get"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /suggestions/drivers
Get Drivers Suggestions
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
limit |
query | integer | 10 | No | |
search_query |
query | string | No | ||
skip |
query | integer | 0 | No |
Response 200 OK
[
{
"value": "string",
"label": "string"
}
]
Schema of the response body
{
"type": "array",
"items": {
"$ref": "#/components/schemas/SuggestionsResponseModel"
},
"title": "Response Get Drivers Suggestions Suggestions Drivers Get"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /suggestions/organizations
Get Organization Suggestions
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
limit |
query | integer | 10 | No | |
search_query |
query | string | No | ||
skip |
query | integer | 0 | No |
Response 200 OK
[
{
"value": "string",
"label": "string"
}
]
Schema of the response body
{
"type": "array",
"items": {
"$ref": "#/components/schemas/SuggestionsResponseModel"
},
"title": "Response Get Organization Suggestions Suggestions Organizations Get"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /suggestions/clients
Get Client Suggestions
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
assignment_enabled |
query | boolean | False | No | |
limit |
query | integer | 10 | No | |
search_query |
query | string | No | ||
skip |
query | integer | 0 | No |
Response 200 OK
[
{
"value": "string",
"label": "string"
}
]
Schema of the response body
{
"type": "array",
"items": {
"$ref": "#/components/schemas/SuggestionsResponseModel"
},
"title": "Response Get Client Suggestions Suggestions Clients Get"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /suggestions/organizations/{org_id}/drivers
Get Org Id Drivers Suggestions
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
limit |
query | integer | 10 | No | |
org_id |
path | string | No | ||
search_query |
query | string | No | ||
skip |
query | integer | 0 | No |
Response 200 OK
[
{
"value": "string",
"label": "string"
}
]
Schema of the response body
{
"type": "array",
"items": {
"$ref": "#/components/schemas/SuggestionsResponseModel"
},
"title": "Response Get Org Id Drivers Suggestions Suggestions Organizations Org Id Drivers Get"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /suggestions/organizations/{org_id}/trailers
Get Trailers From Org Id Suggestions
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
limit |
query | integer | 10 | No | |
org_id |
path | string | No | ||
search_query |
query | string | No | ||
skip |
query | integer | 0 | No |
Response 200 OK
[
{
"value": "string",
"label": "string"
}
]
Schema of the response body
{
"type": "array",
"items": {
"$ref": "#/components/schemas/SuggestionsResponseModel"
},
"title": "Response Get Trailers From Org Id Suggestions Suggestions Organizations Org Id Trailers Get"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /suggestions/organizations/{org_id}/trucks
Get Trucks Suggestions By Org Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
limit |
query | integer | 10 | No | |
org_id |
path | string | No | ||
search_query |
query | string | No | ||
skip |
query | integer | 0 | No |
Response 200 OK
[
{
"value": "string",
"label": "string"
}
]
Schema of the response body
{
"type": "array",
"items": {
"$ref": "#/components/schemas/SuggestionsResponseModel"
},
"title": "Response Get Trucks Suggestions By Org Id Suggestions Organizations Org Id Trucks Get"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /suggestions/subsidiaries
Get Subsidiaries Suggestions
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
limit |
query | integer | 10 | No | |
search_query |
query | string | No | ||
skip |
query | integer | 0 | No |
Response 200 OK
[
{
"value": "string",
"label": "string"
}
]
Schema of the response body
{
"type": "array",
"items": {
"$ref": "#/components/schemas/SuggestionsResponseModel"
},
"title": "Response Get Subsidiaries Suggestions Suggestions Subsidiaries Get"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
advertising
GET /ads-block
Get Ads Blocks
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
assignment |
query | string | No | ||
limit |
query | integer | 200 | No | |
projection |
query | string | No | ||
search |
query | string | No | ||
skip |
query | integer | 0 | No | |
sort |
query | string | No | ||
where |
query | string | No |
Response 200 OK
{
"items": [
{
"title": null,
"target_url": null,
"image_url": null,
"is_active": null,
"etag": null,
"id": "string"
}
],
"total": 0
}
Schema of the response body
{
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/AdvertisingBlockDBModel"
},
"type": "array",
"title": "Items"
},
"total": {
"type": "integer",
"title": "Total"
}
},
"type": "object",
"required": [
"items",
"total"
],
"title": "GenericGetListResponse[AdvertisingBlockDBModel]"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
POST /ads-block
Create Ads
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No |
Request body
{
"title": "string",
"target_url": "string",
"image_url": "string",
"is_active": null
}
Schema of the request body
{
"properties": {
"title": {
"type": "string",
"maxLength": 80,
"title": "Title"
},
"target_url": {
"type": "string",
"title": "Target Url"
},
"image_url": {
"type": "string",
"title": "Image Url"
},
"is_active": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Is Active"
}
},
"type": "object",
"required": [
"title",
"target_url",
"image_url"
],
"title": "CreateAdvertisingBlockModel"
}
Response 201 Created
{
"title": null,
"target_url": null,
"image_url": null,
"is_active": null,
"etag": null,
"id": "string"
}
Schema of the response body
{
"properties": {
"title": {
"anyOf": [
{
"type": "string",
"maxLength": 80
},
{
"type": "null"
}
],
"title": "Title"
},
"target_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Target Url"
},
"image_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image Url"
},
"is_active": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Is Active"
},
"etag": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Etag"
},
"id": {
"type": "string",
"title": "Id"
}
},
"type": "object",
"title": "AdvertisingBlockDBModel"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
DELETE /ads-block/{ads_id}
Remove Ads
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
ads_id |
path | string | No |
Request body
Schema of the request body
{
"anyOf": [
{
"$ref": "#/components/schemas/UpdateAdvertisingBlockModel"
},
{
"type": "null"
}
],
"title": "Resource With Etag"
}
Response 204 No Content
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
PATCH /ads-block/{ads_id}
Update Ads Block
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
ads_id |
path | string | No |
Request body
{
"title": null,
"target_url": null,
"image_url": null,
"is_active": null,
"etag": null
}
Schema of the request body
{
"properties": {
"title": {
"anyOf": [
{
"type": "string",
"maxLength": 80
},
{
"type": "null"
}
],
"title": "Title"
},
"target_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Target Url"
},
"image_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image Url"
},
"is_active": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Is Active"
},
"etag": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Etag"
}
},
"type": "object",
"title": "UpdateAdvertisingBlockModel"
}
Response 200 OK
{
"title": null,
"target_url": null,
"image_url": null,
"is_active": null,
"etag": null,
"id": "string"
}
Schema of the response body
{
"properties": {
"title": {
"anyOf": [
{
"type": "string",
"maxLength": 80
},
{
"type": "null"
}
],
"title": "Title"
},
"target_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Target Url"
},
"image_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image Url"
},
"is_active": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Is Active"
},
"etag": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Etag"
},
"id": {
"type": "string",
"title": "Id"
}
},
"type": "object",
"title": "AdvertisingBlockDBModel"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 404 Not Found
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /ads-block/{ads_id}
Get Ads By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
ads_id |
path | string | No | ||
projection |
query | string | No |
Response 200 OK
{
"title": null,
"target_url": null,
"image_url": null,
"is_active": null,
"etag": null,
"id": "string"
}
Schema of the response body
{
"properties": {
"title": {
"anyOf": [
{
"type": "string",
"maxLength": 80
},
{
"type": "null"
}
],
"title": "Title"
},
"target_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Target Url"
},
"image_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image Url"
},
"is_active": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Is Active"
},
"etag": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Etag"
},
"id": {
"type": "string",
"title": "Id"
}
},
"type": "object",
"title": "AdvertisingBlockDBModel"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 404 Not Found
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
trash
GET /trash-orders
Get Trash
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
assignment |
query | string | No | ||
limit |
query | integer | 200 | No | |
projection |
query | string | No | ||
search |
query | string | No | ||
skip |
query | integer | 0 | No | |
sort |
query | string | No | ||
where |
query | string | No |
Response 200 OK
{
"items": [
{
"id": "string",
"auction_end_time": null,
"stops": null,
"peculiarities": null,
"cargo_type": null,
"truck_body": null,
"client_price": null,
"start_price": null,
"end_price": null,
"currency": null,
"currency_caption": null,
"vat_type": null,
"rate_step": null,
"status": null,
"note": null,
"external": null,
"client": null,
"assigned": null,
"carrier": null,
"driver": null,
"truck": null,
"trailer": null,
"documents": null,
"cancel_reason": null,
"etag": null,
"completed_stages": null,
"created_at": null,
"your_bid": null,
"best_bid": null,
"confirmation_end_time": null,
"reservation_end_time": null,
"short_id": null,
"deleted_at": null,
"current_stage": null,
"document_draft": null,
"start_price_km": null,
"end_price_km": null,
"route_km": null,
"text_search": null,
"updated": null
}
],
"total": 0
}
Schema of the response body
{
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/OrderDBModel"
},
"type": "array",
"title": "Items"
},
"total": {
"type": "integer",
"title": "Total"
}
},
"type": "object",
"required": [
"items",
"total"
],
"title": "GenericGetListResponse[OrderDBModel]"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
PUT /trash-orders/{order_ids}/to-buffer
From Trash To Buf
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
order_ids |
path | string | No |
Response 200 OK
{
"raised_ids": {}
}
Schema of the response body
{
"properties": {
"raised_ids": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Raised Ids"
}
},
"type": "object",
"required": [
"raised_ids"
],
"title": "MultiselectError"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 404 Not Found
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /trash-orders/{order_id}
Get Trash Details
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
order_id |
path | string | No | ||
projection |
query | string | No |
Response 200 OK
{
"id": "string",
"auction_end_time": null,
"stops": null,
"peculiarities": null,
"cargo_type": null,
"truck_body": null,
"client_price": null,
"start_price": null,
"end_price": null,
"currency": null,
"currency_caption": null,
"vat_type": null,
"rate_step": null,
"status": null,
"note": null,
"external": null,
"client": null,
"assigned": null,
"carrier": null,
"driver": null,
"truck": null,
"trailer": null,
"documents": null,
"cancel_reason": null,
"etag": null,
"completed_stages": null,
"created_at": null,
"your_bid": null,
"best_bid": null,
"confirmation_end_time": null,
"reservation_end_time": null,
"short_id": null,
"deleted_at": null,
"current_stage": null,
"document_draft": null,
"start_price_km": null,
"end_price_km": null,
"route_km": null,
"text_search": null,
"updated": null
}
Schema of the response body
{
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"auction_end_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Auction End Time"
},
"stops": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/StopModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Stops"
},
"peculiarities": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"title": "Peculiarities"
},
"cargo_type": {
"anyOf": [
{
"type": "string",
"maxLength": 2048
},
{
"type": "null"
}
],
"title": "Cargo Type"
},
"truck_body": {
"anyOf": [
{
"$ref": "#/components/schemas/BodySettingsModel"
},
{
"type": "null"
}
]
},
"client_price": {
"anyOf": [
{
"type": "integer",
"minimum": 0.0
},
{
"type": "null"
}
],
"title": "Client Price"
},
"start_price": {
"anyOf": [
{
"type": "integer",
"exclusiveMaximum": 100000000.0,
"exclusiveMinimum": 0.0
},
{
"type": "null"
}
],
"title": "Start Price"
},
"end_price": {
"anyOf": [
{
"type": "integer",
"exclusiveMaximum": 100000000.0,
"exclusiveMinimum": 0.0
},
{
"type": "null"
}
],
"title": "End Price"
},
"currency": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency"
},
"currency_caption": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency Caption"
},
"vat_type": {
"anyOf": [
{
"$ref": "#/components/schemas/VATType"
},
{
"type": "null"
}
]
},
"rate_step": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Rate Step"
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderStatus"
},
{
"type": "null"
}
]
},
"note": {
"anyOf": [
{
"type": "string",
"maxLength": 8192
},
{
"type": "null"
}
],
"title": "Note"
},
"external": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderExternalData"
},
{
"type": "null"
}
]
},
"client": {
"anyOf": [
{
"$ref": "#/components/schemas/ClientDBModel"
},
{
"type": "null"
}
]
},
"assigned": {
"anyOf": [
{
"$ref": "#/components/schemas/AssignedModel"
},
{
"type": "null"
}
]
},
"carrier": {
"anyOf": [
{
"$ref": "#/components/schemas/OrganizationDBModel"
},
{
"type": "null"
}
]
},
"driver": {
"anyOf": [
{
"$ref": "#/components/schemas/DriverDBModel"
},
{
"type": "null"
}
]
},
"truck": {
"anyOf": [
{
"$ref": "#/components/schemas/TruckDBModel"
},
{
"type": "null"
}
]
},
"trailer": {
"anyOf": [
{
"$ref": "#/components/schemas/TrailerDBModel"
},
{
"type": "null"
}
]
},
"documents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/DocumentDBModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Documents"
},
"cancel_reason": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"title": "Cancel Reason"
},
"etag": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Etag"
},
"completed_stages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/OrderStageModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Completed Stages"
},
"created_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At"
},
"your_bid": {
"anyOf": [
{
"$ref": "#/components/schemas/BidDBModel"
},
{
"type": "null"
}
]
},
"best_bid": {
"anyOf": [
{
"$ref": "#/components/schemas/BidDBModel"
},
{
"type": "null"
}
]
},
"confirmation_end_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Confirmation End Time"
},
"reservation_end_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Reservation End Time"
},
"short_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Short Id"
},
"deleted_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Deleted At"
},
"current_stage": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderStageModel"
},
{
"type": "null"
}
]
},
"document_draft": {
"anyOf": [
{
"$ref": "#/components/schemas/DocumentDBModel"
},
{
"type": "null"
}
]
},
"start_price_km": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Start Price Km"
},
"end_price_km": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "End Price Km"
},
"route_km": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Route Km"
},
"text_search": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Text Search"
},
"updated": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/UpdateMetadata"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Updated"
}
},
"type": "object",
"title": "OrderDBModel"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 404 Not Found
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
DELETE /trash-orders/{order_ids}
Remove From Trash
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
order_ids |
path | string | No |
Request body
Schema of the request body
{
"anyOf": [
{
"$ref": "#/components/schemas/OrderUpdateModel"
},
{
"type": "null"
}
],
"title": "Order"
}
Response 204 No Content
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
statistics
GET /statistics/company
Get Company Statistics
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No |
Response 200 OK
{
"archive_count": 0,
"active_count": 0,
"unverified_count": 0,
"confirmed_count": 0,
"exchange_count": 0,
"buffer_count": 0,
"canceled_count": 0,
"appointment_count": 0,
"volume_total": 0,
"carriers": {
"registered_count": 0,
"new_count": 0,
"active_bids_count": 0
},
"verifications": {
"carriers_ready_for_check_count": 0,
"drivers_ready_for_check_count": 0,
"trucks_ready_for_check_count": 0,
"trailers_ready_for_check_count": 0
},
"volume_chart": [
{
"key": "string",
"value": 10.12
}
],
"new_carriers_chart": null
}
Schema of the response body
{
"properties": {
"archive_count": {
"type": "integer",
"title": "Archive Count"
},
"active_count": {
"type": "integer",
"title": "Active Count"
},
"unverified_count": {
"type": "integer",
"title": "Unverified Count"
},
"confirmed_count": {
"type": "integer",
"title": "Confirmed Count"
},
"exchange_count": {
"type": "integer",
"title": "Exchange Count"
},
"buffer_count": {
"type": "integer",
"title": "Buffer Count"
},
"canceled_count": {
"type": "integer",
"title": "Canceled Count"
},
"appointment_count": {
"type": "integer",
"title": "Appointment Count"
},
"volume_total": {
"type": "integer",
"title": "Volume Total"
},
"carriers": {
"$ref": "#/components/schemas/CarriersStatisticsModel"
},
"verifications": {
"$ref": "#/components/schemas/VerificationsStatisticsModel"
},
"volume_chart": {
"items": {
"$ref": "#/components/schemas/ChartModel"
},
"type": "array",
"title": "Volume Chart"
},
"new_carriers_chart": {
"items": {
"$ref": "#/components/schemas/ChartModel"
},
"type": "array",
"title": "New Carriers Chart"
}
},
"type": "object",
"required": [
"archive_count",
"active_count",
"unverified_count",
"confirmed_count",
"exchange_count",
"buffer_count",
"canceled_count",
"appointment_count",
"volume_total",
"carriers",
"verifications",
"volume_chart",
"new_carriers_chart"
],
"title": "StatisticsModel"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
GET /statistics/carrier
Get Carriers Main
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No |
Response 200 OK
{
"volume": 0,
"exchange_orders": 0,
"confirmed_orders": 0,
"recommendation_orders": 0,
"volume_chart": [
{
"key": "string",
"value": 10.12
}
]
}
Schema of the response body
{
"properties": {
"volume": {
"type": "integer",
"title": "Volume"
},
"exchange_orders": {
"type": "integer",
"title": "Exchange Orders"
},
"confirmed_orders": {
"type": "integer",
"title": "Confirmed Orders"
},
"recommendation_orders": {
"type": "integer",
"title": "Recommendation Orders"
},
"volume_chart": {
"items": {
"$ref": "#/components/schemas/ChartModel"
},
"type": "array",
"title": "Volume Chart"
}
},
"type": "object",
"required": [
"volume",
"exchange_orders",
"confirmed_orders",
"recommendation_orders",
"volume_chart"
],
"title": "CarrierStatistics"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
subsidiaries
POST /subsidiary
Create Subsidiary
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No |
Request body
{
"name": "string",
"employees": null
}
Schema of the request body
{
"properties": {
"name": {
"type": "string",
"maxLength": 120,
"title": "Name"
},
"employees": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/InsertByUUIDModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Employees"
}
},
"type": "object",
"required": [
"name"
],
"title": "CreateSubsidiaryModel"
}
Response 201 Created
{
"name": null,
"employees": null,
"etag": null,
"id": "string"
}
Schema of the response body
{
"properties": {
"name": {
"anyOf": [
{
"type": "string",
"maxLength": 120
},
{
"type": "null"
}
],
"title": "Name"
},
"employees": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/SotransUserDBModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Employees"
},
"etag": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Etag"
},
"id": {
"type": "string",
"title": "Id"
}
},
"type": "object",
"title": "SubsidiaryDBModel"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /subsidiary
Get Subsidiaries
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
assignment |
query | string | No | ||
limit |
query | integer | 200 | No | |
projection |
query | string | No | ||
search |
query | string | No | ||
skip |
query | integer | 0 | No | |
sort |
query | string | No | ||
where |
query | string | No |
Response 200 OK
{
"items": [
{
"name": null,
"employees": null,
"etag": null,
"id": "string"
}
],
"total": 0
}
Schema of the response body
{
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/SubsidiaryDBModel"
},
"type": "array",
"title": "Items"
},
"total": {
"type": "integer",
"title": "Total"
}
},
"type": "object",
"required": [
"items",
"total"
],
"title": "GenericGetListResponse[SubsidiaryDBModel]"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
PATCH /subsidiary/{sub_id}
Update Subsidiary
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
sub_id |
path | string | No |
Request body
{
"name": null,
"employees": null,
"etag": null
}
Schema of the request body
{
"properties": {
"name": {
"anyOf": [
{
"type": "string",
"maxLength": 120
},
{
"type": "null"
}
],
"title": "Name"
},
"employees": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/InsertByUUIDModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Employees"
},
"etag": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Etag"
}
},
"type": "object",
"title": "UpdateSubsidiaryModel"
}
Response 200 OK
{
"name": null,
"employees": null,
"etag": null,
"id": "string"
}
Schema of the response body
{
"properties": {
"name": {
"anyOf": [
{
"type": "string",
"maxLength": 120
},
{
"type": "null"
}
],
"title": "Name"
},
"employees": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/SotransUserDBModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Employees"
},
"etag": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Etag"
},
"id": {
"type": "string",
"title": "Id"
}
},
"type": "object",
"title": "SubsidiaryDBModel"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 404 Not Found
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
DELETE /subsidiary/{sub_id}
Remove Subsidiary
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
sub_id |
path | string | No |
Request body
Schema of the request body
{
"anyOf": [
{
"$ref": "#/components/schemas/UpdateSubsidiaryModel"
},
{
"type": "null"
}
],
"title": "Resource With Etag"
}
Response 204 No Content
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /subsidiary/{sub_id}
Get Sub By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
projection |
query | string | No | ||
sub_id |
path | string | No |
Response 200 OK
{
"name": null,
"employees": null,
"etag": null,
"id": "string"
}
Schema of the response body
{
"properties": {
"name": {
"anyOf": [
{
"type": "string",
"maxLength": 120
},
{
"type": "null"
}
],
"title": "Name"
},
"employees": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/SotransUserDBModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Employees"
},
"etag": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Etag"
},
"id": {
"type": "string",
"title": "Id"
}
},
"type": "object",
"title": "SubsidiaryDBModel"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 404 Not Found
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
PUT /subsidiary/{subsidiary_id}/clients
Assign Subsidiary To Client
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
client_id |
query | string | No | ||
subsidiary_id |
path | string | No |
Response 200 OK
{
"subsidiary_id": "string",
"clients_ids": [
"string"
]
}
Schema of the response body
{
"properties": {
"subsidiary_id": {
"type": "string",
"title": "Subsidiary Id"
},
"clients_ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Clients Ids"
}
},
"type": "object",
"title": "SubsidiaryClientsModel"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
DELETE /subsidiary/{sub_id}/clients
Revoke Client From Subsidiary
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
client_id |
query | string | No | ||
sub_id |
path | string | No |
Response 200 OK
{
"subsidiary_id": "string",
"clients_ids": [
"string"
]
}
Schema of the response body
{
"properties": {
"subsidiary_id": {
"type": "string",
"title": "Subsidiary Id"
},
"clients_ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Clients Ids"
}
},
"type": "object",
"title": "SubsidiaryClientsModel"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /subsidiary/{sub_id}/clients
Get Subsidiaries Assigned Clients
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
assignment |
query | string | No | ||
limit |
query | integer | 200 | No | |
projection |
query | string | No | ||
search |
query | string | No | ||
skip |
query | integer | 0 | No | |
sort |
query | string | No | ||
sub_id |
path | string | No | ||
where |
query | string | No |
Response 200 OK
{
"items": [
{
"id": "string",
"name": null,
"short_name": null,
"inn": null,
"kpp": null,
"ogrn": null,
"legal_address": null,
"actual_address": null,
"phone": null,
"email": null,
"website": null,
"code_1c": null,
"bank": null,
"bik": null,
"checking_account": null,
"correspondent_account": null,
"responsible": null,
"subsidiary": null,
"note": null,
"etag": null,
"text_search": null
}
],
"total": 0
}
Schema of the response body
{
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/ClientDBModel"
},
"type": "array",
"title": "Items"
},
"total": {
"type": "integer",
"title": "Total"
}
},
"type": "object",
"required": [
"items",
"total"
],
"title": "GenericGetListResponse[ClientDBModel]"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /subsidiary/{sub_id}/orders
Get Assigned Orders By Sub Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
assignment |
query | string | No | ||
limit |
query | integer | 200 | No | |
projection |
query | string | No | ||
search |
query | string | No | ||
skip |
query | integer | 0 | No | |
sort |
query | string | No | ||
sub_id |
path | string | No | ||
where |
query | string | No |
Response 200 OK
{
"items": [
{
"id": "string",
"auction_end_time": null,
"stops": null,
"peculiarities": null,
"cargo_type": null,
"truck_body": null,
"client_price": null,
"start_price": null,
"end_price": null,
"currency": null,
"currency_caption": null,
"vat_type": null,
"rate_step": null,
"status": null,
"note": null,
"external": null,
"client": null,
"assigned": null,
"carrier": null,
"driver": null,
"truck": null,
"trailer": null,
"documents": null,
"cancel_reason": null,
"etag": null,
"completed_stages": null,
"created_at": null,
"your_bid": null,
"best_bid": null,
"confirmation_end_time": null,
"reservation_end_time": null,
"short_id": null,
"deleted_at": null,
"current_stage": null,
"document_draft": null,
"start_price_km": null,
"end_price_km": null,
"route_km": null,
"text_search": null,
"updated": null
}
],
"total": 0
}
Schema of the response body
{
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/OrderDBModel"
},
"type": "array",
"title": "Items"
},
"total": {
"type": "integer",
"title": "Total"
}
},
"type": "object",
"required": [
"items",
"total"
],
"title": "GenericGetListResponse[OrderDBModel]"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /subsidiary/{sub_id}/employees
Get Subsidiaries Employees
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
sub_id |
path | string | No |
Response 200 OK
{
"items": [
{
"email": null,
"name": null,
"surname": null,
"patronymic": null,
"phone": null,
"job_title": null,
"status": null,
"photo": null,
"subsidiary_id": null,
"organization_id": null,
"policy": null,
"note": null,
"username": null,
"id": "string",
"roles": [
"string"
],
"role": "string",
"text_search": null,
"subsidiary_name": null,
"password": null
}
],
"total": 0
}
Schema of the response body
{
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/SotransUserDBModel"
},
"type": "array",
"title": "Items"
},
"total": {
"type": "integer",
"title": "Total"
}
},
"type": "object",
"required": [
"items",
"total"
],
"title": "GenericGetListResponse[SotransUserDBModel]"
}
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
1c
POST /1c/clients
Clients 1C
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
api_key |
query | None | No |
Request body
[
{
"name": null,
"short_name": null,
"inn": "string",
"kpp": null,
"ogrn": null,
"legal_address": null,
"actual_address": null,
"phone": null,
"email": null,
"website": null,
"code_1c": null,
"bank": null,
"bik": null,
"checking_account": null,
"correspondent_account": null,
"responsible": null,
"subsidiary": null,
"note": null
}
]
Schema of the request body
{
"type": "array",
"items": {
"$ref": "#/components/schemas/ClientCreateModel"
},
"title": "Clients"
}
Response 200 OK
Schema of the response body
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
POST /1c/vehicles
Make Vehicles
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
api_key |
query | None | No |
Request body
[
{}
]
Schema of the request body
{
"type": "array",
"items": {
"type": "object"
},
"title": "Vehicles Data"
}
Response 200 OK
Schema of the response body
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
POST /1c/drivers
Make Drivers
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
api_key |
query | None | No |
Request body
[
{}
]
Schema of the request body
{
"type": "array",
"items": {
"type": "object"
},
"title": "Drivers Data"
}
Response 200 OK
Schema of the response body
Response 500 Internal Server Error
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 401 Unauthorized
{
"message": "string"
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorMessage"
}
Response 403 Forbidden
{
"detail": "string"
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorRepr"
}
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
Schemas
AdminSettings
| Name | Type |
|---|---|
confirmation_interval_minutes |
integer |
etag |
|
reservation_interval_minutes |
integer |
AdvertisingBlockDBModel
| Name | Type |
|---|---|
etag |
|
id |
string |
image_url |
|
is_active |
|
target_url |
|
title |
APIKeyDBModel
| Name | Type |
|---|---|
api_key |
|
created_at |
|
id |
string |
name |
|
owner |
AssignedCreateModel
| Name | Type |
|---|---|
company |
AssignedFromCompanyCreate |
AssignedFromCompanyCreate
| Name | Type |
|---|---|
employee |
|
subsidiary |
AssignedFromCompanyDBModel
| Name | Type |
|---|---|
employee |
|
subsidiary |
AssignedModel
| Name | Type |
|---|---|
company |
AssignedToClientResponse
| Name | Type |
|---|---|
client_id |
string |
employees_ids |
Array<string> |
AucEndNotificationCall
| Name | Type |
|---|---|
order_ids |
Array<string> |
AuctionEndNotificationsData
| Name | Type |
|---|---|
orders_dropped |
Array<OrderDBModel> |
orders_taken |
Array<OrderDBModel> |
BidCreateModel
| Name | Type |
|---|---|
value |
integer |
BidDBModel
| Name | Type |
|---|---|
carrier |
|
client_id |
string |
created_at |
|
id |
string |
order_id |
string |
owner |
|
text_search |
|
value |
Body_create_key_api_keys_post
| Name | Type |
|---|---|
name |
string |
Body_import_to_buffer_buffer_orders_xlsx_post
| Name | Type |
|---|---|
xls_file |
string(binary) |
BodySettingsModel
| Name | Type |
|---|---|
body_type |
|
loading_type |
|
volume |
|
weight |
BodyType
Type: string
CarriersStatisticsModel
| Name | Type |
|---|---|
active_bids_count |
integer |
new_count |
integer |
registered_count |
integer |
CarrierStatistics
| Name | Type |
|---|---|
confirmed_orders |
integer |
exchange_orders |
integer |
recommendation_orders |
integer |
volume |
integer |
volume_chart |
Array<ChartModel> |
ChartModel
| Name | Type |
|---|---|
key |
string |
value |
number |
ClientCreateModel
| Name | Type |
|---|---|
actual_address |
|
bank |
|
bik |
|
checking_account |
|
code_1c |
|
correspondent_account |
|
email |
|
inn |
string |
kpp |
|
legal_address |
|
name |
|
note |
|
ogrn |
|
phone |
|
responsible |
|
short_name |
|
subsidiary |
|
website |
ClientDBModel
| Name | Type |
|---|---|
actual_address |
|
bank |
|
bik |
|
checking_account |
|
code_1c |
|
correspondent_account |
|
email |
|
etag |
|
id |
string |
inn |
|
kpp |
|
legal_address |
|
name |
|
note |
|
ogrn |
|
phone |
|
responsible |
|
short_name |
|
subsidiary |
|
text_search |
|
website |
ClientUpdateModel
| Name | Type |
|---|---|
actual_address |
|
bank |
|
bik |
|
checking_account |
|
code_1c |
|
correspondent_account |
|
email |
|
etag |
|
inn |
|
kpp |
|
legal_address |
|
name |
|
note |
|
ogrn |
|
phone |
|
responsible |
|
short_name |
|
subsidiary |
|
website |
ConfirmedOrderUpdateModel
| Name | Type |
|---|---|
assigned |
|
auction_end_time |
|
cancel_reason |
|
cargo_type |
|
carrier |
|
client |
|
client_price |
|
currency |
|
currency_caption |
|
documents |
|
driver |
|
end_price |
|
etag |
|
external |
|
note |
|
peculiarities |
|
rate_step |
|
start_price |
|
status |
|
stops |
|
trailer |
|
truck |
|
truck_body |
|
vat_type |
CreateAdvertisingBlockModel
| Name | Type |
|---|---|
image_url |
string |
is_active |
|
target_url |
string |
title |
string |
CreateSubsidiaryModel
| Name | Type |
|---|---|
employees |
|
name |
string |
CreateUserWithRoleModel
| Name | Type |
|---|---|
email |
|
job_title |
|
name |
string |
note |
|
organization_id |
|
password |
|
patronymic |
|
phone |
|
role |
|
status |
|
surname |
string |
DocumentCreateModel
| Name | Type |
|---|---|
collection |
|
link |
string |
name |
|
note |
|
number |
|
object_id |
|
status |
|
type |
|
valid_until |
DocumentDBModel
| Name | Type |
|---|---|
collection |
|
created_at |
|
deleted_at |
|
etag |
|
id |
string |
link |
|
name |
|
note |
|
number |
|
object_id |
|
organization_id |
|
status |
|
text_search |
|
type |
|
valid_until |
|
verification |
DocumentStatus
Type: string
DocumentUpdateModel
| Name | Type |
|---|---|
collection |
|
etag |
|
link |
|
name |
|
note |
|
number |
|
object_id |
|
status |
|
type |
|
valid_until |
DriverCreateModel
| Name | Type |
|---|---|
code_1c |
|
documents |
|
drivers_license |
DriversLicenseModel |
inn |
string |
name |
string |
note |
|
passport |
PassportModel |
patronymic |
|
phone |
|
photo |
|
status |
|
surname |
string |
DriverDBModel
| Name | Type |
|---|---|
code_1c |
|
created_at |
|
documents |
|
drivers_license |
|
etag |
|
id |
string |
inn |
|
is_active |
|
name |
|
note |
|
organization_id |
string |
passport |
|
patronymic |
|
phone |
|
photo |
|
status |
|
surname |
|
text_search |
|
verification |
DriverDocumentType
Type: string
DriversLicenseModel
| Name | Type |
|---|---|
country |
string |
issued_by |
string |
number |
string |
valid_from |
string(date-time) |
valid_to |
string(date-time) |
DriverStatus
Type: string
DriverUpdateModel
| Name | Type |
|---|---|
code_1c |
|
documents |
|
drivers_license |
|
etag |
|
inn |
|
name |
|
note |
|
passport |
|
patronymic |
|
phone |
|
photo |
|
status |
|
surname |
ErrorMessage
| Name | Type |
|---|---|
message |
string |
ErrorRepr
| Name | Type |
|---|---|
detail |
string |
ExchangeOrderUpdateModel
| Name | Type |
|---|---|
assigned |
|
auction_end_time |
|
cancel_reason |
|
cargo_type |
|
carrier |
|
client |
|
client_price |
|
currency |
|
currency_caption |
|
documents |
|
driver |
|
end_price |
|
etag |
|
external |
|
note |
|
peculiarities |
|
rate_step |
|
start_price |
|
status |
|
stops |
|
trailer |
|
truck |
|
truck_body |
|
vat_type |
ExternalOrderStatus
Type: string
GenericGetListResponse_AdvertisingBlockDBModel_
| Name | Type |
|---|---|
items |
Array<AdvertisingBlockDBModel> |
total |
integer |
GenericGetListResponse_APIKeyDBModel_
| Name | Type |
|---|---|
items |
Array<APIKeyDBModel> |
total |
integer |
GenericGetListResponse_BidDBModel_
| Name | Type |
|---|---|
items |
Array<BidDBModel> |
total |
integer |
GenericGetListResponse_ClientDBModel_
| Name | Type |
|---|---|
items |
Array<ClientDBModel> |
total |
integer |
GenericGetListResponse_DocumentDBModel_
| Name | Type |
|---|---|
items |
Array<DocumentDBModel> |
total |
integer |
GenericGetListResponse_DriverDBModel_
| Name | Type |
|---|---|
items |
Array<DriverDBModel> |
total |
integer |
GenericGetListResponse_OrderDBModel_
| Name | Type |
|---|---|
items |
Array<OrderDBModel> |
total |
integer |
GenericGetListResponse_OrganizationDBModel_
| Name | Type |
|---|---|
items |
Array<OrganizationDBModel> |
total |
integer |
GenericGetListResponse_Recommendation_
| Name | Type |
|---|---|
items |
Array<Recommendation> |
total |
integer |
GenericGetListResponse_SotransUserDBModel_
| Name | Type |
|---|---|
items |
Array<SotransUserDBModel> |
total |
integer |
GenericGetListResponse_SubsidiaryDBModel_
| Name | Type |
|---|---|
items |
Array<SubsidiaryDBModel> |
total |
integer |
GenericGetListResponse_TrailerDBModel_
| Name | Type |
|---|---|
items |
Array<TrailerDBModel> |
total |
integer |
GenericGetListResponse_TruckDBModel_
| Name | Type |
|---|---|
items |
Array<TruckDBModel> |
total |
integer |
GeoLocation
| Name | Type |
|---|---|
latitude |
|
longitude |
HTTPValidationError
| Name | Type |
|---|---|
detail |
Array<ValidationError> |
InnVerificationStatus
Type: string
InsertByOIDModel
| Name | Type |
|---|---|
id |
InsertByUUIDModel
| Name | Type |
|---|---|
id |
LicenseDBModel
| Name | Type |
|---|---|
country |
|
issued_by |
|
number |
|
valid_from |
|
valid_to |
LoadingType
Type: string
MonthlyStatisticsResponse
| Name | Type |
|---|---|
graph |
Array<OneMonthStatsModel> |
total |
integer |
MultiselectError
| Name | Type |
|---|---|
raised_ids |
OneMonthStatsModel
| Name | Type |
|---|---|
key |
integer |
value |
integer |
OrderCreateModel
| Name | Type |
|---|---|
assigned |
|
auction_end_time |
|
cargo_type |
|
carrier |
|
client |
|
client_price |
integer |
currency |
string |
currency_caption |
string |
documents |
|
driver |
|
end_price |
|
external |
|
note |
|
peculiarities |
|
rate_step |
integer |
start_price |
|
status |
|
stops |
Array<StopModel> |
trailer |
|
truck |
|
truck_body |
BodySettingsModel |
vat_type |
OrderDBModel
| Name | Type |
|---|---|
assigned |
|
auction_end_time |
|
best_bid |
|
cancel_reason |
|
cargo_type |
|
carrier |
|
client |
|
client_price |
|
completed_stages |
|
confirmation_end_time |
|
created_at |
|
currency |
|
currency_caption |
|
current_stage |
|
deleted_at |
|
document_draft |
|
documents |
|
driver |
|
end_price |
|
end_price_km |
|
etag |
|
external |
|
id |
string |
note |
|
peculiarities |
|
rate_step |
|
reservation_end_time |
|
route_km |
|
short_id |
|
start_price |
|
start_price_km |
|
status |
|
stops |
|
text_search |
|
trailer |
|
truck |
|
truck_body |
|
updated |
|
vat_type |
|
your_bid |
OrderExternalData
| Name | Type |
|---|---|
additional_ids |
|
best_price |
|
from_exchange |
|
id |
|
original_order |
|
original_status |
|
our_price |
|
resource_name |
|
shared_status |
|
start_price |
|
status |
|
unique_id |
|
url |
OrderStageModel
| Name | Type |
|---|---|
id |
integer |
stop |
|
timestamp |
|
type |
StageType |
OrderStageSubmitModel
| Name | Type |
|---|---|
id |
integer |
OrderStageSuggestModel
| Name | Type |
|---|---|
id |
integer |
label |
string |
OrderStatus
Type: string
OrderUpdateModel
| Name | Type |
|---|---|
assigned |
|
auction_end_time |
|
cancel_reason |
|
cargo_type |
|
carrier |
|
client |
|
client_price |
|
currency |
|
currency_caption |
|
documents |
|
driver |
|
end_price |
|
etag |
|
external |
|
note |
|
peculiarities |
|
rate_step |
|
start_price |
|
status |
|
stops |
|
trailer |
|
truck |
|
truck_body |
|
vat_type |
OrganizationCreateModel
| Name | Type |
|---|---|
bank |
|
bik |
|
contact_user |
|
documents |
|
email |
|
factual_address |
|
head |
|
ifns_code |
|
inn |
string |
kpp |
|
legal_address |
|
logo |
|
name |
|
ogrn |
|
ownership_type |
|
phone |
|
registration_date |
|
short_name |
|
taxation_type |
OrganizationDBModel
| Name | Type |
|---|---|
activity_rating |
|
bank |
|
bik |
|
carriers_rating |
|
carriers_rating_missed |
|
contact_user |
|
created_at |
|
documents |
|
email |
|
etag |
|
factual_address |
|
full_verification |
boolean |
head |
|
id |
string |
ifns_code |
|
inn |
|
inn_verification_status |
|
is_active |
|
kpp |
|
legal_address |
|
logo |
|
name |
|
ogrn |
|
owner |
|
ownership_type |
|
phone |
|
registration_date |
|
short_name |
|
taxation_type |
|
text_search |
|
verification |
OrganizationDocumentType
Type: string
OrganizationUpdateModel
| Name | Type |
|---|---|
bank |
|
bik |
|
contact_user |
|
documents |
|
email |
|
etag |
|
factual_address |
|
head |
|
ifns_code |
|
inn |
|
inn_verification_status |
|
is_active |
|
kpp |
|
legal_address |
|
logo |
|
name |
|
ogrn |
|
ownership_type |
|
phone |
|
registration_date |
|
short_name |
|
taxation_type |
OriginalExternalOrderDBModel
| Name | Type |
|---|---|
auction_end_time |
|
cargo_type |
|
client |
|
client_price |
|
currency |
|
currency_caption |
|
end_price |
|
id |
string |
note |
|
peculiarities |
|
rate_step |
|
start_price |
|
status |
|
stops |
|
truck_body |
|
updated |
|
vat_type |
OwnershipType
Type: string
PassportDBModel
| Name | Type |
|---|---|
birthdate |
|
birthplace |
|
country |
|
issue_date |
|
issued_by |
|
number |
|
registration_address |
|
series |
PassportModel
| Name | Type |
|---|---|
birthdate |
string(date-time) |
birthplace |
string |
country |
string |
issue_date |
string(date-time) |
issued_by |
string |
number |
string |
registration_address |
string |
series |
string |
Processing1CResult
| Name | Type |
|---|---|
code |
|
id |
string |
status |
UpdateStatus |
ProfileCompletionResponse
| Name | Type |
|---|---|
missing |
|
total_percentage |
number |
Recommendation
| Name | Type |
|---|---|
assigned |
|
auction_end_time |
|
best_bid |
|
cancel_reason |
|
cargo_type |
|
carrier |
|
client |
|
client_price |
|
completed_stages |
|
confirmation_end_time |
|
created_at |
|
currency |
|
currency_caption |
|
current_stage |
|
deleted_at |
|
distance_km |
integer |
document_draft |
|
documents |
|
driver |
|
end_price |
|
end_price_km |
|
etag |
|
external |
|
id |
string |
note |
|
peculiarities |
|
rate_step |
|
reservation_end_time |
|
route_km |
|
short_id |
|
start_price |
|
start_price_km |
|
status |
|
stops |
|
text_search |
|
time_gap_hours |
integer |
trailer |
|
truck |
|
truck_body |
|
updated |
|
vat_type |
|
your_bid |
ReportCreateModel
| Name | Type |
|---|---|
description |
|
file_links |
|
submitter |
RequestDocumentType
Type: string
ResourceCheckOrderDBModel
| Name | Type |
|---|---|
assigned |
|
auction_end_time |
|
best_bid |
|
cancel_reason |
|
cargo_type |
|
carrier |
|
client |
|
client_price |
|
completed_stages |
|
confirmation_end_time |
|
created_at |
|
currency |
|
currency_caption |
|
current_stage |
|
deleted_at |
|
document_draft |
|
documents |
|
driver |
|
end_price |
|
end_price_km |
|
etag |
|
external |
|
id |
string |
note |
|
peculiarities |
|
rate_step |
|
reservation_end_time |
|
resource_check_passing |
|
route_km |
|
short_id |
|
start_price |
|
start_price_km |
|
status |
|
stops |
|
text_search |
|
trailer |
|
truck |
|
truck_body |
|
updated |
|
vat_type |
|
your_bid |
ScrapedOrdersCreateModel
| Name | Type |
|---|---|
items |
Array<OrderCreateModel> |
ScrapedOrdersModel
| Name | Type |
|---|---|
items |
Array<OrderDBModel> |
SharedStatus
Type: string
SotransKeycloakUserModel
| Name | Type |
|---|---|
access |
|
attributes |
|
createdTimestamp |
integer |
disableableCredentialTypes |
Array<string> |
email |
|
emailVerified |
boolean |
enabled |
boolean |
id |
string |
job_title |
|
name |
|
notBefore |
integer |
note |
|
organization_id |
|
patronymic |
|
phone |
|
photo |
|
policy |
|
realmRoles |
|
requiredActions |
Array<string> |
role |
string |
roles |
Array<string> |
status |
|
subsidiary_id |
|
surname |
|
totp |
boolean |
username |
SotransKeycloakUserPublicUpdateModel
| Name | Type |
|---|---|
email |
|
job_title |
|
name |
|
note |
|
password |
|
patronymic |
|
phone |
|
photo |
|
role |
|
surname |
SotransKeycloakUserUpdateModel
| Name | Type |
|---|---|
email |
|
job_title |
|
name |
|
note |
|
organization_id |
|
password |
|
patronymic |
|
phone |
|
photo |
|
policy |
|
role |
|
status |
|
subsidiary_id |
|
surname |
SotransRole
Type: string
SotransUserDBModel
| Name | Type |
|---|---|
email |
|
id |
string |
job_title |
|
name |
|
note |
|
organization_id |
|
password |
|
patronymic |
|
phone |
|
photo |
|
policy |
|
role |
string |
roles |
Array<string> |
status |
|
subsidiary_id |
|
subsidiary_name |
|
surname |
|
text_search |
|
username |
StageType
Type: string
StatisticsModel
| Name | Type |
|---|---|
active_count |
integer |
appointment_count |
integer |
archive_count |
integer |
buffer_count |
integer |
canceled_count |
integer |
carriers |
CarriersStatisticsModel |
confirmed_count |
integer |
exchange_count |
integer |
new_carriers_chart |
Array<ChartModel> |
unverified_count |
integer |
verifications |
VerificationsStatisticsModel |
volume_chart |
Array<ChartModel> |
volume_total |
integer |
StopAddress
| Name | Type |
|---|---|
city |
|
country |
|
index |
|
line |
|
location |
|
location_address |
|
province |
StopModel
| Name | Type |
|---|---|
address |
|
datetime |
|
index |
|
note |
|
stop_type |
StopType
Type: string
SubsidiaryClientsModel
| Name | Type |
|---|---|
clients_ids |
Array<string> |
subsidiary_id |
string |
SubsidiaryDBModel
| Name | Type |
|---|---|
employees |
|
etag |
|
id |
string |
name |
SuggestionsResponseModel
| Name | Type |
|---|---|
label |
string |
value |
string |
TrailerCreateModel
| Name | Type |
|---|---|
body |
BodySettingsModel |
brand |
|
code_1c |
|
documents |
|
license_plate |
string |
model |
|
note |
|
ownership_type |
OwnershipType |
registration_country |
VehicleRegistrationCountry |
registration_date |
|
status |
|
sts_number |
string |
sts_series |
string |
vin_number |
TrailerDBModel
| Name | Type |
|---|---|
body |
|
brand |
|
code_1c |
|
created_at |
|
documents |
|
etag |
|
id |
string |
is_active |
|
license_plate |
|
model |
|
note |
|
organization_id |
string |
ownership_type |
|
registration_country |
|
registration_date |
|
status |
|
sts_number |
|
sts_series |
|
text_search |
|
verification |
|
vin_number |
TrailerDocumentType
Type: string
TrailerUpdateModel
| Name | Type |
|---|---|
body |
|
brand |
|
code_1c |
|
documents |
|
etag |
|
license_plate |
|
model |
|
note |
|
ownership_type |
|
registration_country |
|
registration_date |
|
status |
|
sts_number |
|
sts_series |
|
vin_number |
TruckCreateModel
| Name | Type |
|---|---|
body |
BodySettingsModel |
brand |
|
code_1c |
|
documents |
|
license_plate |
string |
model |
|
note |
|
ownership_type |
OwnershipType |
registration_country |
VehicleRegistrationCountry |
registration_date |
|
status |
|
sts_number |
string |
sts_series |
string |
truck_type |
TruckType |
vin_number |
TruckDBModel
| Name | Type |
|---|---|
body |
|
brand |
|
code_1c |
|
created_at |
|
documents |
|
etag |
|
id |
string |
is_active |
|
license_plate |
|
model |
|
note |
|
organization_id |
string |
ownership_type |
|
registration_country |
|
registration_date |
|
status |
|
sts_number |
|
sts_series |
|
text_search |
|
truck_type |
|
verification |
|
vin_number |
TruckDocumentType
Type: string
TruckStatus
Type: string
TruckType
Type: string
TruckUpdateModel
| Name | Type |
|---|---|
body |
|
brand |
|
code_1c |
|
documents |
|
etag |
|
license_plate |
|
model |
|
note |
|
ownership_type |
|
registration_country |
|
registration_date |
|
status |
|
sts_number |
|
sts_series |
|
truck_type |
|
vin_number |
Update1CModel
| Name | Type |
|---|---|
code |
|
collection |
string |
mongo_id |
string |
payload |
|
status |
UpdateStatus |
UpdateAdvertisingBlockModel
| Name | Type |
|---|---|
etag |
|
image_url |
|
is_active |
|
target_url |
|
title |
UpdateINNPayload
| Name | Type |
|---|---|
inn |
string |
UpdateMetadata
| Name | Type |
|---|---|
author |
|
previous_values |
|
timestamp |
UpdateRoleModel
| Name | Type |
|---|---|
role |
SotransRole |
UpdateStatus
Type: string
UpdateSubsidiaryModel
| Name | Type |
|---|---|
employees |
|
etag |
|
name |
UserDocumentType
Type: string
ValidationError
| Name | Type |
|---|---|
loc |
Array<> |
msg |
string |
type |
string |
VATType
Type: string
VehicleRegistrationCountry
Type: string
VerificationCreateModel
| Name | Type |
|---|---|
collection |
|
issuer_type |
VerificationIssuerType |
object_id |
|
status |
VerificationStatus |
VerificationDBModel
| Name | Type |
|---|---|
collection |
string |
id |
string |
issuer_type |
|
object_id |
string |
owner_id |
|
status |
VerificationIssuerType
Type: string
VerificationsStatisticsModel
| Name | Type |
|---|---|
carriers_ready_for_check_count |
integer |
drivers_ready_for_check_count |
integer |
trailers_ready_for_check_count |
integer |
trucks_ready_for_check_count |
integer |
VerificationStatus
Type: string
Security schemes
| Name | Type | Scheme | Description |
|---|---|---|---|
| OAuth2PasswordBearer | oauth2 |
Tags
| Name | Description |
|---|---|
| organizations | Carrier organizations |
Last modified on: 2024-10-10 03:07:55