Поиск роботов
Ищет роботов по фильтрам
Request
POST
/couriers/search
Body
application/json
{
"limit": 1000,
"offset": 0,
"filters": {},
"order": []
}
|
Name |
Description |
|
filters |
Type: api__external__v2__couriers__models__SearchRequestFilters Default: |
|
limit |
Type: integer Default: Min value: Max value: |
|
offset |
Type: integer Default: Min value: |
|
order |
Type: string[] В первом элементе массива нужно передать названия полей сортировки через запятую. Во втором элементе - направление сортировки Default: Min items: Max items: Example |
CourierShiftStatus
Type: string
Enum: off, free, on_delivery, on_battery_change, blocked
api__external__v2__couriers__models__SearchRequestFilters
|
Name |
Description |
|
identifier |
One of 2 types
Example: |
|
shift_status_in |
One of 2 types
Example |
|
shift_status_not_in |
One of 2 types
Example |
Example
{
"shift_status_in": [
"off"
],
"shift_status_not_in": [
null
],
"identifier": "example"
}
Responses
200 OK
Successful Response
Body
application/json
{
"couriers": [
{
"name": "example",
"vin": "example",
"shift_status": "off",
"hatch_status": "opening",
"coordinates": [
0.5,
0.5
],
"yaw": 0.5,
"current_route": [
null
],
"fuel_level": 0,
"claim": {
"created_at": "2025-01-01T00:00:00Z",
"updated_at": "2025-01-01T00:00:00Z",
"finished_at": null,
"id": "example",
"route_points": [
null
],
"current_route_point_id": null,
"external_id": null,
"status": "new",
"version": null,
"user_request_revision": "example",
"eta": null,
"comment": null
}
}
]
}
|
Name |
Description |
|
couriers |
Type: CourierInfoWithClaim[] Example |
HatchStatus
Type: string
Enum: opening, open, closing, closed
TupleCoordinate
Type: number[]
Min items: 2
Max items: 2
Example
[
0.5,
0.5
]
ClaimPointAddress
|
Name |
Description |
|
coordinates |
Type: TupleCoordinate Min items: Max items: Example |
|
building |
One of 2 types
Example: |
|
building_name |
One of 2 types
Example: |
|
city |
One of 2 types
Example: |
|
comment |
One of 2 types
Example: |
|
country |
One of 2 types
Example: |
|
description |
One of 2 types
Example: |
|
door_code |
One of 2 types
Example: |
|
door_code_extra |
One of 2 types
Example: |
|
doorbell_name |
One of 2 types
Example: |
|
fullname |
One of 2 types
Example: |
|
porch |
One of 2 types
Example: |
|
sflat |
One of 2 types
Example: |
|
sfloor |
One of 2 types
Example: |
|
shortname |
One of 2 types
Example: |
|
street |
One of 2 types
Example: |
|
uri |
One of 2 types
Example: |
Example
{
"coordinates": [
0.5,
0.5
],
"fullname": "example",
"building": "example",
"building_name": "example",
"city": "example",
"comment": "example",
"country": "example",
"description": "example",
"door_code": "example",
"door_code_extra": "example",
"doorbell_name": "example",
"porch": "example",
"sflat": "example",
"sfloor": "example",
"shortname": "example",
"street": "example",
"uri": "example"
}
ClaimPointType
Type: string
Enum: source, destination, return
ClaimPointVisitStatus
Type: string
Enum: pending, on_the_way, arrived, in_exchange, completing, visited, skipping, skipped
ClaimPoint
|
Name |
Description |
|
address |
Type: ClaimPointAddress Example |
|
id |
Type: string Example: |
|
type |
One of 2 types
Example: |
|
visit_order |
Type: integer |
|
visit_status |
One of 2 types
Example: |
Example
{
"address": {
"coordinates": [
0.5,
0.5
],
"fullname": "example",
"building": "example",
"building_name": "example",
"city": "example",
"comment": "example",
"country": "example",
"description": "example",
"door_code": "example",
"door_code_extra": "example",
"doorbell_name": "example",
"porch": "example",
"sflat": "example",
"sfloor": "example",
"shortname": "example",
"street": "example",
"uri": "example"
},
"id": "example",
"type": "source",
"visit_order": 0,
"visit_status": "pending"
}
ClaimStatus
Type: string
Enum: new, estimating, estimating_failed, performer_lookup, performer_draft, performer_found, performer_not_found, ready_for_approval, accepted, picking_up, pickup_arrived, ready_for_pickup_confirmation, picked_up, delivering, delivery_arrived, ready_for_delivery_confirmation, delivered, returning, return_arrived, ready_for_return_confirmation, returned, cancelled
Claim
|
Name |
Description |
|
created_at |
Type: string<date-time> Example: |
|
id |
Type: string Example: |
|
route_points |
Type: ClaimPoint[] Example |
|
status |
Type: ClaimStatus Enum: |
|
updated_at |
Type: string<date-time> Example: |
|
user_request_revision |
Type: string Example: |
|
version |
One of 2 types
Example: |
|
comment |
One of 2 types
Example: |
|
current_route_point_id |
One of 2 types
Example: |
|
eta |
One of 2 types
В минутах Example: |
|
external_id |
One of 2 types
Example: |
|
finished_at |
One of 2 types
Example: |
Example
{
"created_at": "2025-01-01T00:00:00Z",
"updated_at": "2025-01-01T00:00:00Z",
"finished_at": "2025-01-01T00:00:00Z",
"id": "example",
"route_points": [
{
"address": {
"coordinates": [
0.5,
0.5
],
"fullname": "example",
"building": "example",
"building_name": "example",
"city": "example",
"comment": "example",
"country": "example",
"description": "example",
"door_code": "example",
"door_code_extra": "example",
"doorbell_name": "example",
"porch": "example",
"sflat": "example",
"sfloor": "example",
"shortname": "example",
"street": "example",
"uri": "example"
},
"id": "example",
"type": "source",
"visit_order": 0,
"visit_status": "pending"
}
],
"current_route_point_id": "example",
"external_id": "example",
"status": "new",
"version": 0,
"user_request_revision": "example",
"eta": 0,
"comment": "example"
}
CourierInfoWithClaim
|
Name |
Description |
|
claim |
One of 2 types
Example |
|
coordinates |
One of 2 types
Example |
|
current_route |
One of 2 types
Example |
|
fuel_level |
One of 2 types
Example: |
|
hatch_status |
One of 2 types
Example: |
|
name |
One of 2 types
Example: |
|
shift_status |
Type: CourierShiftStatus Enum: |
|
vin |
One of 2 types
Example: |
|
yaw |
One of 2 types
Example: |
Example
{
"name": "example",
"vin": "example",
"shift_status": "off",
"hatch_status": "opening",
"coordinates": [
0.5,
0.5
],
"yaw": 0.5,
"current_route": [
null
],
"fuel_level": 0,
"claim": {
"created_at": "2025-01-01T00:00:00Z",
"updated_at": "2025-01-01T00:00:00Z",
"finished_at": "2025-01-01T00:00:00Z",
"id": "example",
"route_points": [
{
"address": {},
"id": "example",
"type": null,
"visit_order": 0,
"visit_status": null
}
],
"current_route_point_id": "example",
"external_id": "example",
"status": "new",
"version": 0,
"user_request_revision": "example",
"eta": 0,
"comment": "example"
}
}
401 Unauthorized
Unauthorized
Body
application/json
{
"code": "UNAUTHORIZED",
"message": "example"
}
|
Name |
Description |
|
code |
Type: string Default: Const: Enum: |
|
message |
Type: string Example: |
403 Forbidden
Forbidden
Body
application/json
{
"code": "FORBIDDEN",
"message": "example"
}
|
Name |
Description |
|
code |
Type: string Default: Const: Enum: |
|
message |
Type: string Example: |
422 Unprocessable Entity
Validation Error
Body
application/json
{
"detail": [
{
"loc": [
"example"
],
"msg": "example",
"type": "example"
}
]
}
|
Name |
Description |
|
detail |
Type: ValidationError[] Example |
ValidationError
|
Name |
Description |
|
loc |
Type: arrayOne of 2 types
Example |
|
msg |
Type: string Example: |
|
type |
Type: string Example: |
Example
{
"loc": [
"example"
],
"msg": "example",
"type": "example"
}