versta.io Open API (v3)
Download OpenAPI specification:Download
Спецификация к открытому API компании Верста. Для работы с API вам необходимо получить ключ доступа. Для получения ключа, пожалуйста, напишите нам на support@versta24.ru.
Получение токена авторизации при помощи apiKey
query Parameters
| accessRights[] | Array of strings Список прав доступа, необходимых для текущего токена. Список прав см. справочник. Данный параметр необязательный, если его не указать, то будут выданы все права, доступные текущему пользователю. |
Responses
Асинхронный расчет вариантов доставки.
Метод запускает асинхронную задачу по расчету вариантов доставки на основе переданных параметров. В случае успешного запуска возвращается ссылка, по которой можно получить статус задачи и результаты расчета по мере их готовности.
Request Body schema: application/json
Параметры для поиска вариантов доставки
required | object Информация об отправителе |
required | object Информация о получателе |
required | object (CargoDescModel) cargoDescModel - описание груза |
object (OptionFilter) Фильтр вариантов доставки по поставщикам и тарифам | |
object (CallCourierPickupInfo) Сведения по забору заказа у отправителя | |
Array of objects or null (Service) Перечень дополнительных услуг (страховка, наложенный платеж, частичный выкуп и т.д.) | |
| receiverDeliveryCharge | number <double> Дополнительный сбор за доставку с получателя. Используется для расчёта комиссии за наложенный платёж |
| companyId | integer or null <int32> Идентификатор компании от которой создается заказ. Если значение не задано, то используется идентификатор компании, которой принадлежит ключ API. Чтобы получить идентификаторы для работы с вашими компаниями, пожалуйста, обратитесь на support@versta24.ru |
Responses
Request samples
- Payload
{- "sender": {
- "contactType": 1,
- "countryId": "RU",
- "cityId": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5",
- "postalCode": "101000",
- "address": "Смоленская площадь, д. 3",
- "loadingWorks": {
- "floor": 2,
- "hasFreightLift": false,
- "loadersCount": 5
}
}, - "receiver": {
- "contactType": 1,
- "countryId": "RU",
- "cityId": "c2deb16a-0330-4f05-821f-1d09c93331e6",
- "postalCode": "190000",
- "address": "ул. Рентгена, 4а"
}, - "cargo": {
- "cargoType": 1,
- "cargoState": 0,
- "isApproximateParameters": true,
- "cargoItems": [
- {
- "weight": 0.5,
- "qty": 2,
- "l": 13.5,
- "h": 10,
- "w": 20,
- "volumeWeight": 0,
- "description": "Ноутбук",
- "volume": 6
}
], - "cargoProducts": [
- {
- "barcode": "string",
- "productId": "A12B3456",
- "name": "Мобильные телефоны Nokia",
- "weight": 0.1,
- "cost": 600,
- "costForReceiver": 800,
- "vatRate": 0,
- "qty": 1,
- "purchasedQty": 0,
- "purchasedAmount": 0,
- "serialNumber": "string",
- "cargoItemIndex": 0
}
], - "description": "Важные документы",
- "customsValue": 100.99,
- "customsCurrency": "RUB",
- "natureOfGoods": "tires",
- "isUsed": true,
- "hsCode": "4901990000"
}, - "optionFilter": {
- "tariffIdFilter": [
- "4",
- "1"
], - "vendorsIdFilter": [
- 0,
- 8
]
}, - "pickupInfo": {
- "autoChangeTakeDate": true,
- "takeDate": "2020-03-31",
- "timeFrom": "12:00",
- "timeTo": "15:00"
}, - "services": [
- {
- "code": "Insurance",
- "parameter": "1000"
}
], - "receiverDeliveryCharge": 100,
- "companyId": null
}Response samples
- 202
- 400
{- "requestId": "983351ff-6cff-4537-ba95-eeac972cacca",
- "retryAfter": 2
}Информация о статусе выполнения расчета доставки.
Метод возвращает текущий статус асинхронного расчета доставки, включая информацию о готовности поставщиков. По умолчанию возвращается только статус выполнения без детальных вариантов доставки. Можно указать поставщика через vendorCode для получения вариантов доставки от конкретного поставщика; Для получения всех вариантов доставки для vendorCode необходимо присвоить 'All'
path Parameters
| requestId required | string Идентификатор операции, по которому осуществляется поиск информации о статусе расчета. |
| vendorCode required | string (Необязательный) Фильтр по поставщику. Если указано, возвращает варианты доставки только от указанного поставщика. Если не указано, возвращаются информацию о результате расчета без вариантов доставки. |
query Parameters
| deliveryType | integer <int32> (ApiDeliveryType) Enum: 0 1 2 3 Фильтр по типу доставки. Если указан, то вернуться только варианты доставки указанного типа. Если не указано, то вернуться все типы посчитанных вариантов доставки. |
Responses
Response samples
- 200
- 400
{- "status": "string",
- "issuedAt": "2024-10-18T10:00:00",
- "expiredAt": "2024-10-18T12:00:00",
- "readyVendors": 3,
- "totalVendors": 5,
- "vendors": [
- {
- "status": "Finished",
- "vendorCode": "Versta"
}
], - "options": [
- {
- "vendorInfo": {
- "vendorId": 0,
- "vendorName": "Versta",
- "vendorContractType": 0
}, - "delivery": {
- "takeDate": "2020-04-16",
- "deliveryDateFrom": "2020-04-16T00:00:00+03:00",
- "deliveryDateTo": "2020-04-17T00:00:00+03:00",
- "minDays": 0,
- "maxDays": 0
}, - "tariff": {
- "tariffId": "4",
- "tariffName": "Срочная",
- "comments": "Москва - Санкт-Петербург Срочная доставка"
}, - "price": {
- "price": 490,
- "tariffPriceOnly": 490,
- "isApproximatePrice": true
}, - "tags": [
- "Авиа"
], - "deliveryType": 0,
- "services": [
- {
- "code": "Insurance",
- "status": 0
}
], - "weightCalc": 0,
- "fromPickupPointType": 0,
- "toPickupPointType": 0
}
], - "requestId": "983351ff-6cff-4537-ba95-eeac972cacca",
- "retryAfter": 2
}
Информация о статусе выполнения расчета доставки.
Метод возвращает текущий статус асинхронного расчета доставки, включая информацию о готовности поставщиков. По умолчанию возвращается только статус выполнения без детальных вариантов доставки. Можно указать поставщика через vendorCode для получения вариантов доставки от конкретного поставщика; Для получения всех вариантов доставки для vendorCode необходимо присвоить 'All'
path Parameters
| requestId required | string Идентификатор операции, по которому осуществляется поиск информации о статусе расчета. |
| vendorCode required | string (Необязательный) Фильтр по поставщику. Если указано, возвращает варианты доставки только от указанного поставщика. Если не указано, возвращаются информацию о результате расчета без вариантов доставки. |
query Parameters
| deliveryType | integer <int32> (ApiDeliveryType) Enum: 0 1 2 3 Фильтр по типу доставки. Если указан, то вернуться только варианты доставки указанного типа. Если не указано, то вернуться все типы посчитанных вариантов доставки. |
Responses
Response samples
- 200
- 400
{- "status": "string",
- "issuedAt": "2024-10-18T10:00:00",
- "expiredAt": "2024-10-18T12:00:00",
- "readyVendors": 3,
- "totalVendors": 5,
- "vendors": [
- {
- "status": "Finished",
- "vendorCode": "Versta"
}
], - "options": [
- {
- "vendorInfo": {
- "vendorId": 0,
- "vendorName": "Versta",
- "vendorContractType": 0
}, - "delivery": {
- "takeDate": "2020-04-16",
- "deliveryDateFrom": "2020-04-16T00:00:00+03:00",
- "deliveryDateTo": "2020-04-17T00:00:00+03:00",
- "minDays": 0,
- "maxDays": 0
}, - "tariff": {
- "tariffId": "4",
- "tariffName": "Срочная",
- "comments": "Москва - Санкт-Петербург Срочная доставка"
}, - "price": {
- "price": 490,
- "tariffPriceOnly": 490,
- "isApproximatePrice": true
}, - "tags": [
- "Авиа"
], - "deliveryType": 0,
- "services": [
- {
- "code": "Insurance",
- "status": 0
}
], - "weightCalc": 0,
- "fromPickupPointType": 0,
- "toPickupPointType": 0
}
], - "requestId": "983351ff-6cff-4537-ba95-eeac972cacca",
- "retryAfter": 2
}