TMS API Перевозчика (v1)

Download OpenAPI specification:

Лента заказов

Получение списка заказов

Получение списка входящих заказов перевозчика

Authorizations:

api_key

query Parameters

page	integer Default: 1 Номер страницы
items	integer <= 100 Default: 20 Кол-во объектов на странице
displayable_scope	string Default: "new" Enum: "new" "bidding" "finished" Скоуп отображаемых заказов `new` - все опубликованные незавершенные заказы `bidding` - все опубликованные незавершенные заказы, в которых я участвую `finished` - все завершенные заказы, в которых я принимал участие По умолчанию - `new`
modality	string Enum: "auto" "sea" "railway" Фильтр по модальности перевозки `auto` - автомобильные `sea` - морские `railway` - железнодорожные
lookup_method_type	string Enum: "reduction" "free_offering" "spot_offer" "target_offer" "quota" Фильтр по типу торга `reduction` - редукцион `free_offering` - сбор предложений `spot_offer` - кто быстрее `target_offer` - целевое предложение `quota` - распределение по гарантии
filter_id	string <uuid> (Uuid) (?i-mx:^[\da-f]{8}-([\da-f]{4}-){3}[\da-f]{12... Example: filter_id=9d82fff9-d029-44b2-b6b7-133b957aa926 ID временного фильтра, который необходимо применить к результирующей выборке

Responses

Response samples

200

Content type

application/json

[{"id": 0,
"lookup_method": {"lookup_method_type": "reduction",
"status": "canceled",
"state": "won",
"possible_bids": [{"price": 0,
"currency": "RUB",
"quantity": 0.1
}
],
"active_bid": {"price": 0,
"currency": "RUB",
"quantity": 0.1,
"max_available_price": 0
},
"other_active_bid": {"price": 0,
"currency": "RUB",
"quantity": 0.1,
"max_available_price": 0
},
"manual_selected_bid": {"price": 0,
"currency": "RUB",
"quantity": 0.1
},
"lost_in_manual_selection_bid": {"price": 0,
"currency": "RUB",
"quantity": 0.1
},
"last_knock_outed_bid": {"price": 0,
"currency": "RUB",
"quantity": 0.1
},
"vat_rate": "vat_20",
"expires_at": { },
"expiration_starts_after": "first_bid"
},
"external_number": "string",
"provider": "string",
"created_at": "2016-07-20T14:54:31.903+03:00",
"quantity": 0.1,
"unit": "ton",
"customer_name": "string",
"vehicle_capacity": {"weight_capacity": 0,
"cubic_capacity": 0
},
"transport_type": "string",
"vehicle_types": ["string"
],
"cargo_description": "string",
"cargo_packaging_type": "string",
"cargo_packaging_quantity": "string",
"cargo_weight_per_unit": "string",
"order_type": "general",
"containers_count": 0,
"modality": "auto",
"hazardous_cargo": true,
"hazard_category": "string",
"first_point_data": {"contractor": "string",
"expected_arrival_time": {"type": "plain",
"date": {"type": "determined",
"exact_value": "2016-07-20"
},
"time": {"type": "determined",
"exact_value": "20:00"
},
"comment": "string"
},
"country_iso_code": "string",
"region_iso_code": "string",
"city": "string",
"settlement": "string",
"address": "string"
},
"last_point_data": {"contractor": "string",
"expected_arrival_time": {"type": "plain",
"date": {"type": "determined",
"exact_value": "2016-07-20"
},
"time": {"type": "determined",
"exact_value": "20:00"
},
"comment": "string"
},
"country_iso_code": "string",
"region_iso_code": "string",
"city": "string",
"settlement": "string",
"address": "string"
}
}
]

Получение детальной информации о заказе

Authorizations:

api_key

Responses

Response samples

200

Content type

application/json

{"id": 0,
"external_number": "string",
"provider": "string",
"customer_name": "string",
"customer_inn": "string",
"customer_kpp": "string",
"lookup_method": {"lookup_method_type": "reduction",
"status": "canceled",
"state": "won",
"possible_bids": [{"price": 0,
"currency": "RUB",
"quantity": 0.1
}
],
"active_bid": {"price": 0,
"currency": "RUB",
"quantity": 0.1,
"max_available_price": 0
},
"other_active_bid": {"price": 0,
"currency": "RUB",
"quantity": 0.1,
"max_available_price": 0
},
"manual_selected_bid": {"price": 0,
"currency": "RUB",
"quantity": 0.1
},
"lost_in_manual_selection_bid": {"price": 0,
"currency": "RUB",
"quantity": 0.1
},
"last_knock_outed_bid": {"price": 0,
"currency": "RUB",
"quantity": 0.1
},
"vat_rate": "vat_20",
"expires_at": { },
"expiration_starts_after": "first_bid",
"duration": 0,
"starting_price": 0,
"starting_cost": 0,
"step_type": "exact",
"exact_step": 0,
"percent_step": 0,
"total_bids_count": 0,
"owned_bids": [{"id": "9d82fff9-d029-44b2-b6b7-133b957aa926",
"status": "active",
"price": {"with_vat": 0,
"without_vat": 0
},
"cost": {"with_vat": 0,
"without_vat": 0
},
"currency": "RUB",
"vat_rate": "vat_20",
"quantity": 0.1,
"comment": "string",
"expires_at": { }
}
],
"execution_request_uids": ["string"
],
"available_actions": ["make_bid"
]
},
"created_at": "2016-07-20T14:54:31.903+03:00",
"quantity": 0.1,
"unit": "ton",
"vehicle_capacity": {"weight_capacity": 0,
"cubic_capacity": 0
},
"transport_type": "string",
"external_transport_type": "string",
"vehicle_types": ["string"
],
"cargo_description": "string",
"cargo_packaging_type": "string",
"cargo_packaging_quantity": 0,
"cargo_weight_per_unit": "string",
"order_type": "general",
"containers_count": 0,
"modality": "auto",
"hazardous_cargo": true,
"hazard_category": "string",
"incoterms": "EXW",
"public_comment": "string",
"driver_requirements": "string",
"tms_url": "string",
"points": [{"id": "9d82fff9-d029-44b2-b6b7-133b957aa926",
"action": "string",
"contractor": {"name": "string",
"inn": "string",
"kpp": "string"
},
"contacts": [{"name": "string",
"phone": "string",
"email": "string"
}
],
"description": "string",
"loading_type": "rear",
"address": {"id": "9d82fff9-d029-44b2-b6b7-133b957aa926",
"full_value": "560657 Россия, Киров, проспект Сосновый, 222",
"source": "da_data",
"external_number": "string",
"country_iso_code": "RU",
"region_iso_code": "RU-ROS",
"region_edm_code": "string",
"country_name": "Россия",
"region_name": "Ростовская область",
"area": "Чеховский",
"area_type_full": "район",
"city": "Астрахань",
"city_type_full": "город",
"settlement": "Ивановка",
"settlement_type_full": "деревня",
"postal_code": 248017,
"street": "Строительная ул.",
"house": 37,
"block": "корп. 1",
"time_zone": "Europe/Moscow",
"coords": {"lat": 40.240186,
"lon": 50.361656
}
},
"expected_arrival_time": {"type": "plain",
"date": {"type": "determined",
"exact_value": "2016-07-20"
},
"time": {"type": "determined",
"exact_value": "20:00"
},
"comment": "string"
},
"digital_queue": {"id": { },
"name": "string"
}
}
],
"custom_attributes": [{"id": "9d82fff9-d029-44b2-b6b7-133b957aa926",
"value": "string",
"type": "string",
"name": "string",
"entity_type": "string",
"definition_id": "9d82fff9-d029-44b2-b6b7-133b957aa926",
"definition_slug": "string",
"position": 0,
"reading_only": true
}
],
"extra_services": [{"id": "9d82fff9-d029-44b2-b6b7-133b957aa926",
"count": 0,
"description": "string",
"name": "string",
"extra_name": "string",
"context": "for_order",
"unit": "per_km",
"as_pricing_factor": true,
"currency": "RUB",
"order_point_id": { },
"execution_request_point_id": { },
"run_point_id": { },
"identifier": "string",
"approval": {"id": "9d82fff9-d029-44b2-b6b7-133b957aa926",
"iid": 0,
"status": "pending",
"retries_count": 0
},
"prices": {"price": {"vat_rate": "vat_20",
"without_vat": 0,
"with_vat": 0
}
}
}
]
}

Сохранение временного фильтра

Authorizations:

api_key

Request Body schema: application/json

required	Array of objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects
operator	string Default: "and" Value: "and" Оператор условия where для связывания нескольких фильтров

Responses

Request samples

Payload

Content type

application/json

{"filters": [{"field": "first_point_location",
"filter_type": "radius",
"value": {"lat": 52.721246,
"lon": 41.452238,
"radius": 50
}
}
],
"operator": "and"
}

Response samples

200

Content type

application/json

{"id": "9d82fff9-d029-44b2-b6b7-133b957aa926"
}

Справочники

Получение списка типов транспортных средств

Получение списка всех имеющихся в системе типов транспортных средств

Authorizations:

api_key

Responses

Response samples

200

Content type

application/json

[{"id": "9d82fff9-d029-44b2-b6b7-133b957aa926",
"name": "string"
}
]

Торги Редукцион

Подать ставку (подбор с типом Редукцион)

Authorizations:

api_key

Request Body schema: application/json

required

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"bids": [{"price": 0,
"quantity": 0.1,
"comment": "string",
"expires_at": { }
}
]
}

Торги Кто быстрее

Принять предложение (подбор с типом Кто быстрее)

Authorizations:

api_key