Skip to main content
API docs by Redocly

versta.io Open API (v3)

Download OpenAPI specification:Download

Спецификация к открытому API компании Верста. Для работы с API вам необходимо получить ключ доступа. Для получения ключа, пожалуйста, напишите нам на support@versta24.ru.

Auth

Получение токена авторизации при помощи apiKey

query Parameters
accessRights[]
Array of strings

Список прав доступа, необходимых для текущего токена. Список прав см. справочник. Данный параметр необязательный, если его не указать, то будут выданы все права, доступные текущему пользователю.

Responses

Calc

Асинхронный расчет вариантов доставки.

Метод запускает асинхронную задачу по расчету вариантов доставки на основе переданных параметров. В случае успешного запуска возвращается ссылка, по которой можно получить статус задачи и результаты расчета по мере их готовности.

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

Content type
application/json
{
  • "sender": {
    },
  • "receiver": {
    },
  • "cargo": {
    },
  • "optionFilter": {
    },
  • "pickupInfo": {
    },
  • "services": [
    ],
  • "receiverDeliveryCharge": 100,
  • "companyId": null
}

Response samples

Content type
application/json
{}

Информация о статусе выполнения расчета доставки.

Метод возвращает текущий статус асинхронного расчета доставки, включая информацию о готовности поставщиков. По умолчанию возвращается только статус выполнения без детальных вариантов доставки. Можно указать поставщика через vendorCode для получения вариантов доставки от конкретного поставщика; Для получения всех вариантов доставки для vendorCode необходимо присвоить 'All'

path Parameters
requestId
required
string

Идентификатор операции, по которому осуществляется поиск информации о статусе расчета.

vendorCode
required
string

(Необязательный) Фильтр по поставщику. Если указано, возвращает варианты доставки только от указанного поставщика. Если не указано, возвращаются информацию о результате расчета без вариантов доставки.

query Parameters
deliveryType
integer <int32> (ApiDeliveryType)
Enum: 0 1 2 3

Фильтр по типу доставки. Если указан, то вернуться только варианты доставки указанного типа. Если не указано, то вернуться все типы посчитанных вариантов доставки.
0 - Дверь-Дверь
1 - Дверь-ПВЗ
2 - ПВЗ-ПВЗ
3 - ПВЗ-Дверь

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "issuedAt": "2024-10-18T10:00:00",
  • "expiredAt": "2024-10-18T12:00:00",
  • "readyVendors": 3,
  • "totalVendors": 5,
  • "vendors": [],
  • "options": [
    ],
  • "location": "https://api.versta24.ru/openapi/v3-beta/calc/983351ff-6cff-4537-ba95-eeac972cacca",
  • "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

Фильтр по типу доставки. Если указан, то вернуться только варианты доставки указанного типа. Если не указано, то вернуться все типы посчитанных вариантов доставки.
0 - Дверь-Дверь
1 - Дверь-ПВЗ
2 - ПВЗ-ПВЗ
3 - ПВЗ-Дверь

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "issuedAt": "2024-10-18T10:00:00",
  • "expiredAt": "2024-10-18T12:00:00",
  • "readyVendors": 3,
  • "totalVendors": 5,
  • "vendors": [],
  • "options": [
    ],
  • "location": "https://api.versta24.ru/openapi/v3-beta/calc/983351ff-6cff-4537-ba95-eeac972cacca",
  • "requestId": "983351ff-6cff-4537-ba95-eeac972cacca",
  • "retryAfter": 2
}