Перейти к основному содержимому
API docs by Redocly

versta.io Open API (v2)

Download OpenAPI specification:Download

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

Attachments

attachments - загрузка файла и привязка к указанной сущности

Загружает файл в ситему верста и привязывает к указанной в запросе сущности. К примеру, как приложение к заказу.

header Parameters
Authorization
required
string
Example: apiKey 3590fb7e-7f7d-4afb-b095-43acff08c2b2

Заголовок авторизации в формате: apiKey значение_ключа

Request Body schema: application/json

Метаданные файла и файл в base64 кодировке

name
string or null

Название файла

mimeType
string or null

MIME-тип файла

itemType
integer

Тип сущности, к которой привязывается файл
0 = Order - К заказу versta24
1 = ProfLogVendor - Поставщик профлог
2 = Resource - Информационный файл
3 = PickupPoint - Пункт выдачи заказов

itemId
string or null

Идентификатор сущности, к которой привязывается файл

fileType
integer

Тип содержимого файла. Можно использовать как маску
0 = None - Без типа
1 = AttachedFile - Вложение
2 = OrderPrintedInvoice - Распечатанная накладная заказа
4 = InsurancePolicy - Страховка
8 = CargoBarcode - Штрихкод груза
16 = OrderSourceFile - Исходный файл создания заказа
32 = InvoiceScan - Скан накладной
64 = YotaContract - Договор Yota
128 = OrderTemplateAttachedFile - Шаблон файла загрузки для договора
256 = PaymentAccount - Данные плательщика
512 = ZipInvoiceScans - Архив сканов накладных
1024 = Registry - Реестр по заказу
2048 = ZipRegistries - Архив реестров по заказу
4096 = LoadingPhoto - Фото погрузки
8192 = UnloadingPhoto - Фото разгрузки
16384 = Documents - Документы
32768 = MailingSource - Исходный файл рассылки

base64File
string or null

Файл, закодированный в base64-строку

accessLevel
integer
Enum: 1 2 4 0 1 2 3

Уровень доступа к файлу
1 = Admin - Доступен только администраторам versta24
2 = AuthorizedUser - Доступен всем авторизованным пользователям
4 = NotAuthorizedUser - Доступен всем

Responses

Request samples

Content type
application/json
{
  • "name": "file.pdf",
  • "mimeType": "application/pdf",
  • "itemType": 0,
  • "itemId": "V24X-XXX-XXX-XXX",
  • "fileType": 1,
  • "base64File": "0J/RgNC40LzQtdGAINGB0YLRgNC+0LrQuCDQsiBiYXNlNjQ=",
  • "accessLevel": 2
}

Response samples

Content type
application/json
{}

attachments - скачивание файла с указанным идентификатором

Позволяет скачать файл из системы верста.

path Parameters
attachmentId
required
string

Guid-идентификатор файла

header Parameters
Authorization
required
string
Example: apiKey 3590fb7e-7f7d-4afb-b095-43acff08c2b2

Заголовок авторизации в формате: apiKey значение_ключа

Responses

Response samples

Content type
No sample

attachments - метаданные файла с указанным идентификатором

Возвращает метаданные файла со ссылкой для скачивания.

path Parameters
attachmentId
required
string

Guid-идентификатор файла

header Parameters
Authorization
required
string
Example: apiKey 3590fb7e-7f7d-4afb-b095-43acff08c2b2

Заголовок авторизации в формате: apiKey значение_ключа

Responses

Response samples

Content type
application/json
{}

Calc

calc - расчет стоимости

Рассчитывает стоимость по переданным параметрам и возвращает возможные варианты доставки для отображения пользователю.

header Parameters
Authorization
required
string
Example: apiKey 3590fb7e-7f7d-4afb-b095-43acff08c2b2

Заголовок авторизации в формате: apiKey значение_ключа

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
{
  • "options": [
    ]
}

calc/byDays - расчет стоимости доставок с разбивкой на возможные даты доставки

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

header Parameters
Authorization
required
string
Example: apiKey 3590fb7e-7f7d-4afb-b095-43acff08c2b2

Заголовок авторизации в формате: apiKey значение_ключа

Request Body schema: application/json

Параметры для поиска вариантов доставки

daysToCalculate
required
integer <int32>

Кол-во календарных дней, на которое нужно сделать расчет. Задается целым числом. Дни считаются с сегодня. Например, если нам нужно сделать расчет на 7 дней вперед, то указываем 7. Обязательный параметр

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
{
  • "daysToCalculate": 0,
  • "sender": {
    },
  • "receiver": {
    },
  • "cargo": {
    },
  • "optionFilter": {
    },
  • "pickupInfo": {
    },
  • "services": [
    ],
  • "receiverDeliveryCharge": 100,
  • "companyId": null
}

Response samples

Content type
application/json
{
  • "deliveryDays": [
    ]
}

Companies

Создание компании и пользователя к этой компании

Если SendUserCredentialByEmail - true, отправляем логин и пароль новому пользователю.

header Parameters
PartnerKey
string
Example: 82117599-5a11-444d-8738-c52a1de08706

Идентификатор партнера. Необязательный параметр

Authorization
required
string
Example: apiKey 3590fb7e-7f7d-4afb-b095-43acff08c2b2

Заголовок авторизации в формате: apiKey значение_ключа

Request Body schema: application/json
companyName
required
string non-empty

Название компании

vatNumber
string or null

ИНН

kpp
string or null

КПП

object (BankAccount)

Банковские реквизиты

contactName
required
string non-empty

Имя пользователя

contactPhone
string or null

Телефон пользователя

contactEmail
required
string non-empty

E-mail пользователя

generateApiKey
boolean

Нужно ли сгенерировать ApiKey новому пользователю

sendUserCredentialByEmail
boolean

Нужно ли отправить email новому пользователю с логином и паролем

comment
string or null

Комментарий в свободной форме к создаваемой компании

Responses

Request samples

Content type
application/json
{
  • "companyName": "ООО Тестовая комапания",
  • "vatNumber": "789456123789",
  • "kpp": "321654987",
  • "bankAccount": {
    },
  • "contactName": "Петров Петр",
  • "contactPhone": "+79115554433",
  • "contactEmail": "petrov_petr@gmail.com",
  • "generateApiKey": true,
  • "sendUserCredentialByEmail": true,
  • "comment": "Комментарий к данной компании"
}

Response samples

Content type
application/json
{
  • "userApiKey": "b9edb7b5-3673-4005-ae88-ef827edh2da6"
}

Получение счета на пополнение баланса

query Parameters
id
integer <int32>

Идентификатор компании. Необязательный параметр

amount
required
number <double>

Сумма пополнения баланса компании. Cумма указывается в рублях. Обязательный параметр, положительное дробное или целое число

header Parameters
Authorization
required
string
Example: apiKey 3590fb7e-7f7d-4afb-b095-43acff08c2b2

Заголовок авторизации в формате: apiKey значение_ключа

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Получение текущего баланса компании

path Parameters
id
required
string

ИНН или идентификатор компании

header Parameters
Authorization
required
string
Example: apiKey 3590fb7e-7f7d-4afb-b095-43acff08c2b2

Заголовок авторизации в формате: apiKey значение_ключа

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "vatNumber": "1181111110",
  • "name": "ООО Ромашка",
  • "amount": 34830.25,
  • "currencyId": "RUB"
}

Получение истории изменения баланса компании

path Parameters
id
required
string

ИНН или идентификатор компании

query Parameters
page
integer <int32>

Номер страницы, можно не передавать, если запрашивается первая страница

header Parameters
Authorization
required
string
Example: apiKey 3590fb7e-7f7d-4afb-b095-43acff08c2b2

Заголовок авторизации в формате: apiKey значение_ключа

Responses

Response samples

Content type
application/json
{}

NatureOfGoods

Список доступных характеров грузов. Используйте возвращённый code в поле cargo.natureOfGoods при создании заказа или расчёте

Возвращает список номенклатуры грузов с внутренними кодами Versta. Поиск осуществляется по названию (регистронезависимый, поддерживает смену раскладки клавиатуры). Если параметр searchQuery не указан, возвращаются все доступные записи (с учётом count).

query Parameters
Count
integer <int32>

Максимальное число элементов в результате поиска

SearchQuery
string

Строка, по которой осуществляется поиск

header Parameters
Authorization
required
string
Example: apiKey 3590fb7e-7f7d-4afb-b095-43acff08c2b2

Заголовок авторизации в формате: apiKey значение_ключа

Responses

Response samples

Content type
application/json
{
  • "values": [
    ],
  • "totalCount": 0
}

Получить информацию о характере груза по коду Versta

path Parameters
code
required
string

Внутренний код Versta (например, "tires", "documents")

header Parameters
Authorization
required
string
Example: apiKey 3590fb7e-7f7d-4afb-b095-43acff08c2b2

Заголовок авторизации в формате: apiKey значение_ключа

Responses

Response samples

Content type
application/json
{
  • "code": "tires",
  • "name": "Шины"
}

Orders

Создание заказа

Создает заказ с переданными параметрами в статусе Запрос ставки (RateRequest) и передает его поставщику на выполнение
Для того, чтобы заказ был сразу передан поставщику, необходимо указать поля VendorId и TariffId в Option

header Parameters
PartnerKey
string
Example: 82117599-5a11-444d-8738-c52a1de08706

Идентификатор партнера. Необязательный параметр

Authorization
required
string
Example: apiKey 3590fb7e-7f7d-4afb-b095-43acff08c2b2

Заголовок авторизации в формате: apiKey значение_ключа

Request Body schema: application/json

Параметры создаваемого заказа

required
object

Информация об отправителе

required
object

Информация о получателе

required
object (CargoDescModel)

cargoDescModel - описание груза

required
object (Option)

Выбранный вариант доставки

object (OrderRequestPickupInfo)

Сведения по забору заказа у отправителя

comments
string or null

Общий комментарий, примечания к заказу

Array of objects or null (Service)

Перечень дополнительных услуг (страховка, возврат груза и т.д.)

companyId
integer or null <int32>

Идентификатор компании от которой создается заказ. Если значение не задано, то используется идентификатор компании, которой принадлежит ключ API. Чтобы получить идентификаторы для работы с вашими компаниями, пожалуйста, обратитесь на support@versta24.ru

project
string or null

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

department
string or null

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

customerOrderId
string or null

Произвольная строка с номером заказа клиента. Сохраняется в заказе

customerOrderIdDontCheck
boolean

Не проверять дублирование номера заказа клиента. Если установлен в false - то при сохранении заказа проверяется отсутствие дублей по указанному номеру заказа клиента По умолчанию: true

customerActNumber
string or null <= 100 characters

№ Акта/ТТН клиента

receiverDeliveryCharge
number <double>

Дополнительный сбор за доставку с получателя

receiverDeliveryChargeVatRate
integer <int32> (ApiVatRate)
Enum: 0 5 7 10 18 20 22

Ставка НДС
VAT0 - НДС 0%
VAT5 - НДС 5%
VAT7 - НДС 7%
VAT10 - НДС 10%
VAT18 - НДС 18%
VAT20 - НДС 20%
VAT22 - НДС 22% \

emergencyEmail
string or null

E-mail адрес, на который будут приходить письма в случае если заказ не удалось передать поставщику по причине не доступности поставщика. На этот же e-mail будут приходить письма, когда заказ будет передан.

isDraft
boolean

Признак, что нужно создать только черновик закзаа. Если true, то заказ не будет передан поставщику. По умолчанию, false

Responses

Request samples

Content type
application/json
{
  • "sender": {
    },
  • "receiver": {
    },
  • "cargo": {
    },
  • "option": {
    },
  • "pickupInfo": {
    },
  • "comments": "Требуется доупаковка на складе",
  • "services": [
    ],
  • "companyId": null,
  • "project": "Доставка товаров",
  • "department": "Логистика",
  • "customerOrderId": "MX123456",
  • "customerOrderIdDontCheck": true,
  • "customerActNumber": "A-654",
  • "receiverDeliveryCharge": 100,
  • "receiverDeliveryChargeVatRate": 0,
  • "emergencyEmail": "emergency@email.com",
  • "isDraft": false
}

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "result": {
    },
  • "messages": [
    ]
}

Получить список заказов

Возвращает список заказов по переданному фильтру

query Parameters
ordersId[]
Array of strings
Example: ordersId[]=V243-700-000-001&ordersId[]=V243-700-000-002

Фильтр по номерам заказа. Может быть указаны следующие номера:

  • номер заказа верста - OrderId - V24X-XXX-XXX-XXX
  • клиентский номер заказа - CustomerOrderId
  • номер накладной поставщика VendorInvoiceNumber
CreateDateFrom
string
Example: CreateDateFrom=2020-03-30

Дата создания заказа в формате yyyy-MM-dd, начиная с которой включительно выполняется выборка заказов

CreateDateTo
string
Example: CreateDateTo=2020-03-31

Дата создания заказа в формате yyyy-MM-dd, до которой включительно выполняется выборка заказов

TakeDateFrom
string
Example: TakeDateFrom=2020-03-30

Дата забора в формате yyyy-MM-dd, начиная с которой включительно выполняется выборка заказов

TakeDateTo
string
Example: TakeDateTo=2020-03-31

Дата забора в формате yyyy-MM-dd, до которой включительно выполняется выборка заказов

Department
string
Example: Department=Финансы

Фильтр по аналитике "подразделение" из заказов. Сравнение происходит регистронезависимо, но совпадение должно быть 100%

Project
string
Example: Project=Маркетплейсы

Фильтр по аналитике "проект" из заказов. Сравнение происходит регистронезависимо, но совпадение должно быть 100%

header Parameters
Authorization
required
string
Example: apiKey 3590fb7e-7f7d-4afb-b095-43acff08c2b2

Заголовок авторизации в формате: apiKey значение_ключа

Responses

Response samples

Content type
application/json
{
  • "orders": [
    ]
}

Получить заказ по orderId

Возвращает полную информацию о заказе по его orderId

path Parameters
orderId
required
string
Example: V24X-XXX-XXX-XXX-XXX

Номер заказа versta24, клиентский номер или номер накладной поставщика

query Parameters
searchMode
integer <int32> (OrderIdSearchMode)
Enum: 0 1 2 3 4 5 6

Какому полю должен соответствовать orderId, без указания параметра поиск будет производиться по номеру заказа versta24.

0 - По номеру заказа в системе Верста (ByVerstaNum)

1 - По номеру накладной поставщика (ByVendorInvoiceNum)

2 - По номеру возвратной накладной поставщика (ByVendorReturnInvoiceNum)

3 - По номеру заказа или вызова курьера поставщика (ByVendorPickupNum)

4 - По клиентскому номеру (ByCustomerNum)

5 - По дополнительному номеру для трекинга (ByTrackingId)

6 - По всем номерам заказа (ByAll)

header Parameters
Authorization
required
string
Example: apiKey 3590fb7e-7f7d-4afb-b095-43acff08c2b2

Заголовок авторизации в формате: apiKey значение_ключа

Responses

Response samples

Content type
application/json
{
  • "order": {
    }
}

Обновить данные заказа

Обновляет данные в заказе

path Parameters
orderId
required
string
Example: V24X-XXX-XXX-XXX

Номер заказа versta24, клиентский номер или номер накладной поставщика

query Parameters
searchMode
integer <int32> (OrderIdSearchMode)
Enum: 0 1 2 3 4 5 6

Какому полю должен соответствовать orderId, без указания параметра поиск будет производиться по номеру заказа versta24.

0 - По номеру заказа в системе Верста (ByVerstaNum)

1 - По номеру накладной поставщика (ByVendorInvoiceNum)

2 - По номеру возвратной накладной поставщика (ByVendorReturnInvoiceNum)

3 - По номеру заказа или вызова курьера поставщика (ByVendorPickupNum)

4 - По клиентскому номеру (ByCustomerNum)

5 - По дополнительному номеру для трекинга (ByTrackingId)

6 - По всем номерам заказа (ByAll)

header Parameters
Authorization
required
string
Example: apiKey 3590fb7e-7f7d-4afb-b095-43acff08c2b2

Заголовок авторизации в формате: apiKey значение_ключа

Request Body schema: application/json
changes
required
object

Изменения, которые нужно внести. Нужно указать точное названия поля, учитывая регистр
Если поле вложенное, то его необходимо указать через точку. Например "sender.name"

Responses

Request samples

Content type
application/json
{
  • "changes": {
    }
}

Response samples

Content type
application/json
{
  • "order": {
    }
}

Отмена заказа

Создает запрос на отмену заказа и возвращает результат создания этого запроса. Следует обратить внимание, что по правилам тарифного положения бесплатная отмена заказа доступна только в течении 20 минут после его создания. Далее за каждый отмененный заказ может взиматься плата, согласно тарифу (см. тарифное положение)

path Parameters
orderId
required
string
Example: V24X-XXX-XXX-XXX

Номер заказа versta24, клиентский номер или номер накладной поставщика

query Parameters
searchMode
integer <int32> (OrderIdSearchMode)
Enum: 0 1 2 3 4 5 6

Какому полю должен соответствовать orderId, без указания параметра поиск будет производиться по номеру заказа versta24.

0 - По номеру заказа в системе Верста (ByVerstaNum)

1 - По номеру накладной поставщика (ByVendorInvoiceNum)

2 - По номеру возвратной накладной поставщика (ByVendorReturnInvoiceNum)

3 - По номеру заказа или вызова курьера поставщика (ByVendorPickupNum)

4 - По клиентскому номеру (ByCustomerNum)

5 - По дополнительному номеру для трекинга (ByTrackingId)

6 - По всем номерам заказа (ByAll)

header Parameters
Authorization
required
string
Example: apiKey 3590fb7e-7f7d-4afb-b095-43acff08c2b2

Заголовок авторизации в формате: apiKey значение_ключа

Responses

Response samples

Content type
application/json
{
  • "orderId": "V24X-XXX-XXX-XXX",
  • "cancelled": true
}

track - отслеживание заказов

Возвращает отслеживание по заказу.

path Parameters
orderId
required
string
Example: V24X-XXX-XXX-XXX

Номер заказа versta24, клиентский номер или номер накладной поставщика

query Parameters
searchMode
integer <int32> (OrderIdSearchMode)
Enum: 0 1 2 3 4 5 6

Какому полю должен соответствовать orderId, без указания параметра поиск будет производиться по номеру заказа versta24.

0 - По номеру заказа в системе Верста (ByVerstaNum)

1 - По номеру накладной поставщика (ByVendorInvoiceNum)

2 - По номеру возвратной накладной поставщика (ByVendorReturnInvoiceNum)

3 - По номеру заказа или вызова курьера поставщика (ByVendorPickupNum)

4 - По клиентскому номеру (ByCustomerNum)

5 - По дополнительному номеру для трекинга (ByTrackingId)

6 - По всем номерам заказа (ByAll)

header Parameters
Authorization
required
string
Example: apiKey 3590fb7e-7f7d-4afb-b095-43acff08c2b2

Заголовок авторизации в формате: apiKey значение_ключа

Responses

Response samples

Content type
application/json
{
  • "events": [
    ]
}

print - Печать накладной по заказу

Возвращает pdf файл с накладной по конкретному заказу. Распечатать накладную или ШК грузомест можно только по заказам, которые уже были в статусе "Передан поставщику" и не отменены

path Parameters
orderId
required
string
Example: V24X-XXX-XXX-XXX

Номер заказа versta24, клиентский номер или номер накладной поставщика

docType
integer <int32> (ApiPrintDocTypes)
Enum: 0 1 2 4 8 16

Тип печатаемого файла. Можно использовать как маску Invoice = 1 - Накладная заказа,

Barcode = 2 - Штрихкод груза,

InsurancePolicy = 4 - Страховка,

InvoiceScan = 8 - Скан накладной,

DeliveryConfirmation = 16 - Подтверждение заказа

query Parameters
searchMode
integer <int32> (OrderIdSearchMode)
Enum: 0 1 2 3 4 5 6

Какому полю должен соответствовать orderId, без указания параметра поиск будет производиться по номеру заказа versta24.

0 - По номеру заказа в системе Верста (ByVerstaNum)

1 - По номеру накладной поставщика (ByVendorInvoiceNum)

2 - По номеру возвратной накладной поставщика (ByVendorReturnInvoiceNum)

3 - По номеру заказа или вызова курьера поставщика (ByVendorPickupNum)

4 - По клиентскому номеру (ByCustomerNum)

5 - По дополнительному номеру для трекинга (ByTrackingId)

6 - По всем номерам заказа (ByAll)

InvoiceCopy
integer <int32>
Example: InvoiceCopy=2

Количество копий накладной. По умолчанию - 2

PrintInvoice
boolean

Печатать накладную. По умолчанию - true

PrintInsurancePolicy
boolean

Печатать страховой полис

PrintCargoMarks
boolean

Печатать грузовые марки

marksFormat
integer <int32> (ApiMarksFormat)
Enum: 0 1 2 3

Формат печатаемого штрихкода.

A4 = 0,

A5 = 1,

A6 = 2,

A7 = 3

header Parameters
Authorization
required
string
Example: apiKey 3590fb7e-7f7d-4afb-b095-43acff08c2b2

Заголовок авторизации в формате: apiKey значение_ключа

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

print - формирование печатного документа

Возвращает pdf файл с накладной по конкретному заказу вместе с переданным в запросе документом клиента. Распечатать накладную или ШК грузомест можно только по заказам, которые уже были в статусе "Передан поставщику" и не отменены

path Parameters
orderId
required
string
Example: V24X-XXX-XXX-XXX

Номер заказа versta24, клиентский номер или номер накладной поставщика

docType
integer <int32> (ApiPrintDocTypes)
Enum: 0 1 2 4 8 16

Тип печатаемого файла. Можно использовать как маску Invoice = 1 - Накладная заказа,

Barcode = 2 - Штрихкод груза,

InsurancePolicy = 4 - Страховка,

DeliveryConfirmation = 16 - Подтверждение заказа

query Parameters
searchMode
integer <int32> (OrderIdSearchMode)
Enum: 0 1 2 3 4 5 6

Какому полю должен соответствовать orderId, без указания параметра поиск будет производиться по номеру заказа versta24.

0 - По номеру заказа в системе Верста (ByVerstaNum)

1 - По номеру накладной поставщика (ByVendorInvoiceNum)

2 - По номеру возвратной накладной поставщика (ByVendorReturnInvoiceNum)

3 - По номеру заказа или вызова курьера поставщика (ByVendorPickupNum)

4 - По клиентскому номеру (ByCustomerNum)

5 - По дополнительному номеру для трекинга (ByTrackingId)

6 - По всем номерам заказа (ByAll)

InvoiceCopy
integer <int32>
Example: InvoiceCopy=2

Количество копий накладной. По умолчанию - 2

PrintInvoice
boolean

Печатать накладную. По умолчанию - true

PrintInsurancePolicy
boolean

Печатать страховой полис

PrintCargoMarks
boolean

Печатать грузовые марки

marksFormat
integer <int32> (ApiMarksFormat)
Enum: 0 1 2 3

Формат печатаемого штрихкода.

A4 = 0,

A5 = 1,

A6 = 2,

A7 = 3

header Parameters
Authorization
required
string
Example: apiKey 3590fb7e-7f7d-4afb-b095-43acff08c2b2

Заголовок авторизации в формате: apiKey значение_ключа

Request Body schema: application/json

Сведения о документе, который нужно соединить с файлом печатной накладной

includePdf
string or null

base-64 строка Pdf-файла для соединения с накладной

includePosition
integer <int32> (ApiIncludeFilePosition)
Enum: 0 1
includeCopy
integer <int32>

Количество копий IncludePdf файла. По умолчанию - 1

Responses

Request samples

Content type
application/json
{
  • "includePdf": "aW5jbHVkZSBwZGYgYmFzZTY0IHN0cmluZw==",
  • "includePosition": 0,
  • "includeCopy": 0
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

print - формирование печатного документа по нескольким заказам

Возвращает pdf файл с накладной по конкретному заказу вместе с переданным в запросе документом клиента. Распечатать накладную или ШК грузомест можно только по заказам, которые уже были в статусе "Передан поставщику" и не отменены

path Parameters
docType
required
integer <int32> (ApiPrintDocTypes)
Enum: 0 1 2 4 8 16

Тип печатаемого файла. Можно использовать как маску Invoice = 1 - Накладная заказа,

Barcode = 2 - Штрихкод груза,

InsurancePolicy = 4 - Страховка,

DeliveryConfirmation = 16 - Подтверждение заказа

query Parameters
ordersId[]
required
Array of strings

Список номеров заказа versta24

searchMode
integer <int32> (OrderIdSearchMode)
Enum: 0 1 2 3 4 5 6

Какому полю должен соответствовать orderId, без указания параметра поиск будет производиться по номеру заказа versta24.

0 - По номеру заказа в системе Верста (ByVerstaNum)

1 - По номеру накладной поставщика (ByVendorInvoiceNum)

2 - По номеру возвратной накладной поставщика (ByVendorReturnInvoiceNum)

3 - По номеру заказа или вызова курьера поставщика (ByVendorPickupNum)

4 - По клиентскому номеру (ByCustomerNum)

5 - По дополнительному номеру для трекинга (ByTrackingId)

6 - По всем номерам заказа (ByAll)

InvoiceCopy
integer <int32>
Example: InvoiceCopy=2

Количество копий накладной. По умолчанию - 2

PrintInvoice
boolean

Печатать накладную. По умолчанию - true

PrintInsurancePolicy
boolean

Печатать страховой полис

PrintCargoMarks
boolean

Печатать грузовые марки

marksFormat
integer <int32> (ApiMarksFormat)
Enum: 0 1 2 3

Формат печатаемого штрихкода.

A4 = 0,

A5 = 1,

A6 = 2,

A7 = 3

header Parameters
Authorization
required
string
Example: apiKey 3590fb7e-7f7d-4afb-b095-43acff08c2b2

Заголовок авторизации в формате: apiKey значение_ключа

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

pushToVendor - Передача заказа поставщику

Передает сохраненный заказ выбранному поставщику с выбранным вариантом доставки.

Если не были переданы параметры в запросе, то берем из заказа

path Parameters
orderId
required
string
Example: V24X-XXX-XXX-XXX

Номер заказа versta24, клиентский номер или номер накладной поставщика

query Parameters
searchMode
integer <int32> (OrderIdSearchMode)
Enum: 0 1 2 3 4 5 6

Какому полю должен соответствовать orderId, без указания параметра поиск будет производиться по номеру заказа versta24.

0 - По номеру заказа в системе Верста (ByVerstaNum)

1 - По номеру накладной поставщика (ByVendorInvoiceNum)

2 - По номеру возвратной накладной поставщика (ByVendorReturnInvoiceNum)

3 - По номеру заказа или вызова курьера поставщика (ByVendorPickupNum)

4 - По клиентскому номеру (ByCustomerNum)

5 - По дополнительному номеру для трекинга (ByTrackingId)

6 - По всем номерам заказа (ByAll)

header Parameters
Authorization
required
string
Example: apiKey 3590fb7e-7f7d-4afb-b095-43acff08c2b2

Заголовок авторизации в формате: apiKey значение_ключа

Request Body schema: application/json

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

object (Option)

Выбранный вариант доставки

object (OrderRequestPickupInfo)

Сведения по забору заказа у отправителя

Responses

Request samples

Content type
application/json
{
  • "option": {
    },
  • "pickupInfo": {
    }
}

Response samples

Content type
application/json
{
  • "location": "https://api.versta24.ru/openapi/v2/orders/V24X-XXX-XXX-XXX",
  • "orderId": "V24X-XXX-XXX-XXX",
  • "orderKey": "xxxxxxx",
  • "vendorInvoiceNum": "62377725-23",
  • "vendorPickupNum": "4562389-78",
  • "customerOrderId": "MX123456",
  • "price": 200,
  • "planDeliveryDate": "2020-04-18T00:00:00",
  • "vendorInfo": {},
  • "status": 60,
  • "statusName": "Передан поставщику",
  • "emergencyEmail": "emergency@e-mail.com"
}

callCourier - вызов курьера

path Parameters
orderId
required
string
Example: V24X-XXX-XXX-XXX

Номер заказа versta24, клиентский номер или номер накладной поставщика

query Parameters
searchMode
integer <int32> (OrderIdSearchMode)
Enum: 0 1 2 3 4 5 6

Какому полю должен соответствовать orderId, без указания параметра поиск будет производиться по номеру заказа versta24.

0 - По номеру заказа в системе Верста (ByVerstaNum)

1 - По номеру накладной поставщика (ByVendorInvoiceNum)

2 - По номеру возвратной накладной поставщика (ByVendorReturnInvoiceNum)

3 - По номеру заказа или вызова курьера поставщика (ByVendorPickupNum)

4 - По клиентскому номеру (ByCustomerNum)

5 - По дополнительному номеру для трекинга (ByTrackingId)

6 - По всем номерам заказа (ByAll)

header Parameters
Authorization
required
string
Example: apiKey 3590fb7e-7f7d-4afb-b095-43acff08c2b2

Заголовок авторизации в формате: apiKey значение_ключа

Request Body schema: application/json

Параметры для вызова курьера

autoChangeTakeDate
boolean

Если true, то система будет пытаться автоматически поменять дату забора на ближайший доступный день, если на дату, заданную в TakeDate, передача заказа с заданными VendorId и TariffId невозможна. По умолчанию, true. ПАРАМЕТР УСТАРЕЛ И БУДЕТ УДАЛЁН.

takeDate
string or null

Указывается дата забора груза в формате yyyy-MM-dd. По умолчанию - текущая дата. Не все поставщики могут выполнять забор в выходные дни. Также существуют ограничения на время размещения заказа с датой забора сегодня. Ближайшая доступная дата забора заказа возвращается в варианте доставки в takeDate.

timeFrom
string <date-span>

Указывается ограничение на время забора (начальное). Это ограничение носит рекомендательный характер и не всегда может быть соблюдено. По умолчанию указывается время забора 09:00.

timeTo
string <date-span>

Указывается ограничение на время забора (конечное). Это ограничение носит рекомендательный характер и не всегда может быть соблюдено. По умолчанию указывается время забора 18:00.

Responses

Request samples

Content type
application/json
{
  • "autoChangeTakeDate": true,
  • "takeDate": "2020-03-31",
  • "timeFrom": "12:00",
  • "timeTo": "15:00"
}

Response samples

Content type
application/json
{
  • "result": {
    },
  • "messages": [
    ]
}

Получить отчет по списку заказов по выбранному шаблону

Возвращает указанные в шаблоне отчета поля по каждому заказу из отфильтрованного списка

query Parameters
TemplateId
required
integer <int32>
Example: TemplateId=123

Id шаблона отчета

ordersId[]
Array of strings
Example: ordersId[]=V243-700-000-001&ordersId[]=V243-700-000-002

Фильтр по номерам заказа. Может быть указаны следующие номера:

  • номер заказа верста - OrderId - V24X-XXX-XXX-XXX
  • клиентский номер заказа - CustomerOrderId
  • номер накладной поставщика VendorInvoiceNumber
CreateDateFrom
string
Example: CreateDateFrom=2020-03-30

Дата создания заказа в формате yyyy-MM-dd, начиная с которой включительно выполняется выборка заказов

CreateDateTo
string
Example: CreateDateTo=2020-03-31

Дата создания заказа в формате yyyy-MM-dd, до которой включительно выполняется выборка заказов

TakeDateFrom
string
Example: TakeDateFrom=2020-03-30

Дата забора в формате yyyy-MM-dd, начиная с которой включительно выполняется выборка заказов

TakeDateTo
string
Example: TakeDateTo=2020-03-31

Дата забора в формате yyyy-MM-dd, до которой включительно выполняется выборка заказов

Department
string
Example: Department=Финансы

Фильтр по аналитике "подразделение" из заказов. Сравнение происходит регистронезависимо, но совпадение должно быть 100%

Project
string
Example: Project=Маркетплейсы

Фильтр по аналитике "проект" из заказов. Сравнение происходит регистронезависимо, но совпадение должно быть 100%

header Parameters
Authorization
required
string
Example: apiKey 3590fb7e-7f7d-4afb-b095-43acff08c2b2

Заголовок авторизации в формате: apiKey значение_ключа

Responses

Response samples

Content type
application/json
{
  • "values": [
    ],
  • "totalCount": 0
}

Получить вложенные заказы

Возвращает список вложенных заказов для переданного главного

path Parameters
orderId
required
string
Example: V24X-XXX-XXX-XXX-XXX

Номер заказа versta24, клиентский номер или номер накладной поставщика

query Parameters
searchMode
integer <int32> (OrderIdSearchMode)
Enum: 0 1 2 3 4 5 6

Какому полю должен соответствовать orderId, без указания параметра поиск будет производиться по номеру заказа versta24.

0 - По номеру заказа в системе Верста (ByVerstaNum)

1 - По номеру накладной поставщика (ByVendorInvoiceNum)

2 - По номеру возвратной накладной поставщика (ByVendorReturnInvoiceNum)

3 - По номеру заказа или вызова курьера поставщика (ByVendorPickupNum)

4 - По клиентскому номеру (ByCustomerNum)

5 - По дополнительному номеру для трекинга (ByTrackingId)

6 - По всем номерам заказа (ByAll)

header Parameters
Authorization
required
string
Example: apiKey 3590fb7e-7f7d-4afb-b095-43acff08c2b2

Заголовок авторизации в формате: apiKey значение_ключа

Responses

Response samples

Content type
application/json
{
  • "orders": [
    ]
}

Возвращает ссылку на оплату заказа

path Parameters
orderId
required
string
header Parameters
Authorization
required
string
Example: apiKey 3590fb7e-7f7d-4afb-b095-43acff08c2b2

Заголовок авторизации в формате: apiKey значение_ключа

Responses

PickupPoints

List - список пунктов выдачи и приемки заказов

Возвращает список пунктов выдачи и приемки заказов по заданным фильтрам географии, постащику, характеру и параметрам груза

query Parameters
VendorId
integer <int32>
Example: VendorId=1

Необязательный параметр. Фильтр по одному поставщику. Если указан идентификатор поставщика, то возвращаются только точки выдачи конкретного поставщика. Если данный параметр не указан, то возвращается список точек выдачи всех доступных поставщиков. Приоритет: если указан VendorId, параметр VendorIds игнорируется.

VendorIds
Array of integers <int32> [ items <int32 > ]

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

CargoQty
integer <int32>
Example: CargoQty=1

Необязательный параметр. Фильтр по количеству грузомест, которое может принять пункт выдачи и приемки заказов

TotalWeight
number <double>
Example: TotalWeight=1.5

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

MaxWidth
number <double>
Example: MaxWidth=15

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

MaxLength
number <double>
Example: MaxLength=16

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

MaxHeight
number <double>
Example: MaxHeight=25

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

Mode
integer <int32> (PickupPointModes)
Enum: 1 2
Example: Mode=3

Режимы работы ПВЗ

Intake=1 На приём отправлений

Pickup=2 На выдачу отправлений

По умолчанию может работать как на выдачу, так и на приём

Type
integer <int32> (ApiPickupPointType)
Enum: 0 1 2 3 4 5

Тип ПВЗ

0 - ПВЗ
1 - Постомат
2 - Абонентский ящик
3 - Маркетплейс

services
Array of strings

Список кодов услуг. Например: Check

Список услуг см. справочник

MinLat
number <double>

Минимальная широта bounding box (южная граница), [-90, 90]. Используется для запроса ПВЗ без указания города. Если город определён, bbox игнорируется. Требует указания VendorId или VendorIds.

MaxLat
number <double>

Максимальная широта bounding box (северная граница), [minLat, 90]

MinLon
number <double>

Минимальная долгота bounding box (западная граница), [-180, 180]

MaxLon
number <double>

Максимальная долгота bounding box (восточная граница), [minLon, 180]

PageNum
integer <int32>

Номер страницы. Необязательный параметр для получения результатов постранично.

PageSize
integer <int32>

Размер страницы. Необязательный параметр для получения результатов постранично. Постраничный вывод работает только если оба параметра заданы корректно.

CountryId
required
string
Example: CountryId=RU

Возвращает список пунктов выдачи и приемки заказов по заданным фильтрам географии, постащику, характеру и параметрам груза

CityId
string
Example: CityId=0c5b2444-70a0-4932-980c-b4dc0d3f02b5

Фильтр пунктов выдачи и приемки заказов по id города. Код города или населенного пункта. Для населенных пуктов внутри РФ - необходимо указывать код ФИАС (уровень 4 или 6) или КЛАДР, для населенных пунктов за пределами РФ - Идентификатор объекта в базе GeoNames (https://ru.wikipedia.org/wiki/GeoNames). Город должен попадать в указанную в параметре country страну. Если не указан, поиск будет осуществляться по названию города (CityName) или по координатам (Bbox). Если не указано ничего, поиск будет осуществляться по всей стране. Имеет приоритет над CityName и параметрами Bbox.

SenderCityId
string
Example: SenderCityId=0c5b2444-70a0-4932-980c-b4dc0d3f02b5

Фильтр точек выдачи по городу отправителя. Необязательный параметр. Код города или населенного пункта. Для населенных пуктов внутри РФ - необходимо указывать код ФИАС (уровень 4 или 6) или КЛАДР, для населенных пунктов за пределами РФ - Идентификатор объекта в базе GeoNames (https://ru.wikipedia.org/wiki/GeoNames).

SenderCountryId
string
Example: SenderCountryId=RU

Указывается двухбуквенный код страны отправителя в соответсвии с ISO 3166-1 alpha-2 (https://ru.wikipedia.org/wiki/ISO_3166-1). Необязательный параметр.

CityName
string
Example: CityName=Москва

Фильтр пунктов выдачи и приемки заказов по названию города. Город должен попадать в указанную в параметре country страну. Имеет меньший приоритет при поиске, чем CityId

header Parameters
Authorization
required
string
Example: apiKey 3590fb7e-7f7d-4afb-b095-43acff08c2b2

Заголовок авторизации в формате: apiKey значение_ключа

Responses

Response samples

Content type
application/json
{}

Получение деталей о пункте выдачи заказов по ключу поставщика и Id ПВЗ.

path Parameters
vendorKey
required
string

Ключ поставщика

ppId
required
string

Id ПВЗ

query Parameters
CountryId
required
string
Example: CountryId=RU

Возвращает список пунктов выдачи и приемки заказов по заданным фильтрам географии, постащику, характеру и параметрам груза

CityId
string
Example: CityId=0c5b2444-70a0-4932-980c-b4dc0d3f02b5

Фильтр пунктов выдачи и приемки заказов по id города. Код города или населенного пункта. Для населенных пуктов внутри РФ - необходимо указывать код ФИАС (уровень 4 или 6) или КЛАДР, для населенных пунктов за пределами РФ - Идентификатор объекта в базе GeoNames (https://ru.wikipedia.org/wiki/GeoNames). Город должен попадать в указанную в параметре country страну. Если не указан, поиск будет осуществляться по названию города (CityName) или по координатам (Bbox). Если не указано ничего, поиск будет осуществляться по всей стране. Имеет приоритет над CityName и параметрами Bbox.

SenderCityId
string
Example: SenderCityId=0c5b2444-70a0-4932-980c-b4dc0d3f02b5

Фильтр точек выдачи по городу отправителя. Необязательный параметр. Код города или населенного пункта. Для населенных пуктов внутри РФ - необходимо указывать код ФИАС (уровень 4 или 6) или КЛАДР, для населенных пунктов за пределами РФ - Идентификатор объекта в базе GeoNames (https://ru.wikipedia.org/wiki/GeoNames).

SenderCountryId
string
Example: SenderCountryId=RU

Указывается двухбуквенный код страны отправителя в соответсвии с ISO 3166-1 alpha-2 (https://ru.wikipedia.org/wiki/ISO_3166-1). Необязательный параметр.

CityName
string
Example: CityName=Москва

Фильтр пунктов выдачи и приемки заказов по названию города. Город должен попадать в указанную в параметре country страну. Имеет меньший приоритет при поиске, чем CityId

header Parameters
Authorization
required
string
Example: apiKey 3590fb7e-7f7d-4afb-b095-43acff08c2b2

Заголовок авторизации в формате: apiKey значение_ключа

Responses

Response samples

Content type
application/json
{
  • "country": "RU",
  • "cityId": "5bf5ddff-6353-4a3d-80c4-6fb27f00c6c1",
  • "cityName": "Воронеж г.",
  • "address": "[СДЭК] ул Ясеневая, 50 [MSK299]",
  • "pickupPointId": "MSK299",
  • "vendorId": 0,
  • "vendorInfo": {},
  • "metroStation": "Московская",
  • "metroLineHexColor": "FFCD1C",
  • "workTime": "пн-пт 9-18, сб 9-16",
  • "pickupPointUrl": "https://my.versta24.ru/offises/postamat-omnisdek-234",
  • "photos": [],
  • "latitude": 54.50598,
  • "longitude": 36.25166,
  • "name": "[СДЭК] ул Ясеневая, 50",
  • "color": "green",
  • "type": 0,
  • "description": "15 мин от станции метро...",
  • "phone": "+79998887766",
  • "freeStorageDays": 2,
  • "cashPayment": true,
  • "cardPayment": false,
  • "minWeight": null,
  • "maxWeight": 15,
  • "maxWidth": 64.5,
  • "maxHeight": 36.5,
  • "maxDepth": 40.5,
  • "totalMaxVolume": 0.4,
  • "maxSizeSum": 250,
  • "mode": 1
}

Calc - cписок пунктов выдачи и приемки заказов и тарифы доставки до них

Возвращает список пунктов выдачи и приемки заказов c рассчитанными вариантами доставки.

query Parameters
mode
integer <int32> (PickupPointModes)
Enum: 1 2

Необязательный параметр. Фильтр по режиму работы ПВЗ, Pickup или Intake, по умолчанию - Pickup

type
integer <int32> (ApiPickupPointType)
Enum: 0 1 2 3 4 5

Необязательный параметр. Фильтр по типу ПВЗ. Тип ПВЗ:

            0 - ПВЗ \
            1 - Постомат \
            2 - Абонентский ящик \
            3 - Маркетплейс
services
Array of strings

Необязательный параметр, фильтр по дополнительным услугам, оказываемым на ПВЗ.

header Parameters
Authorization
required
string
Example: apiKey 3590fb7e-7f7d-4afb-b095-43acff08c2b2

Заголовок авторизации в формате: apiKey значение_ключа

Request Body schema:

Параметры для расчета стоимости доставки до ПВЗ

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
{
  • "sender": {
    },
  • "receiver": {
    },
  • "cargo": {
    },
  • "optionFilter": {
    },
  • "pickupInfo": {
    },
  • "services": [
    ],
  • "receiverDeliveryCharge": 100,
  • "companyId": null
}

Response samples

Content type
application/json
{
  • "pickupPoints": [
    ]
}

pickupPointsMap - карта пунктов выдачи заказов

query Parameters
token
string

Ключ API

cityId
string

Идентификатор города в ФИАС

vendorId
integer <int32>

Код поставщика для которого нужно вернуть ПВЗ. Если не задан - то возвращается для всех доступных данному пользователю. Пример - 8 для СДЭК

withPriceCalc
boolean
Default: false

Указывает нужно ли при отображение точек доставки также считать стоимость. По-умолчанию, - false

weight
number <double>
Default: 0

Если задан параметр withPriceCalc - то в этом параметре необходимо задать вес для расчета в кг

header Parameters
Authorization
required
string
Example: apiKey 3590fb7e-7f7d-4afb-b095-43acff08c2b2

Заголовок авторизации в формате: apiKey значение_ключа

Responses

Settings

settings - список пользовательских настроек

Возвращает список с информацией о настройках.

header Parameters
Authorization
required
string
Example: apiKey 3590fb7e-7f7d-4afb-b095-43acff08c2b2

Заголовок авторизации в формате: apiKey значение_ключа

Responses

Response samples

Content type
application/json
{
  • "settings": [
    ]
}

settings - управление настройками

Меняет параметры настроек. Для простых настроек (code "toggle") достаточно параметра "enable".

path Parameters
settingsKey
required
string

Ключ-идентификатор настройки

header Parameters
Authorization
required
string
Example: apiKey 3590fb7e-7f7d-4afb-b095-43acff08c2b2

Заголовок авторизации в формате: apiKey значение_ключа

Request Body schema: application/json

Поля и значения настройки в соответствии со схемой

enable
boolean

Включить/выключить настройку

object or null

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

Responses

Request samples

Content type
application/json
{
  • "enable": true,
  • "fields": {
    }
}

Response samples

Content type
application/json
{
  • "name": "Разрешить выбор языка",
  • "key": "canSelectLanguage",
  • "value": "true",
  • "schemaLink": "https://api.versta24.ru/OpenApi/v2/Settings/canSelectLanguage/schema",
  • "access": 0,
  • "description": "Даем возможность клиенту выбрать язык ЛК. У пользователя появится переключатель языков"
}

settings - значение и описание настройки

Описание пользовательской настройки со ссылкой на схему.

path Parameters
settingsKey
required
string

Ключ-идентификатор настройки

header Parameters
Authorization
required
string
Example: apiKey 3590fb7e-7f7d-4afb-b095-43acff08c2b2

Заголовок авторизации в формате: apiKey значение_ключа

Responses

Response samples

Content type
application/json
{
  • "name": "Разрешить выбор языка",
  • "key": "canSelectLanguage",
  • "value": "true",
  • "schemaLink": "https://api.versta24.ru/OpenApi/v2/Settings/canSelectLanguage/schema",
  • "access": 0,
  • "description": "Даем возможность клиенту выбрать язык ЛК. У пользователя появится переключатель языков"
}

settings - схема

Схема с параметрами, необходимыми для включения профиля

path Parameters
settingsKey
required
string

Ключ-идентификатор настройки

header Parameters
Authorization
required
string
Example: apiKey 3590fb7e-7f7d-4afb-b095-43acff08c2b2

Заголовок авторизации в формате: apiKey значение_ключа

Responses

Response samples

Content type
application/json
{
  • "settings": [
    ]
}

Tariffs

Список тарифов. По всем поставщикам или запрошенных по vendorId или vendorKey

query Parameters
VendorId
integer <int32>
Example: VendorId=1

Идентификатор поставщика. Значение integer

VendorKey
string
Example: VendorKey=CSE

Ключ поставщика. Строковое значение

header Parameters
Authorization
required
string
Example: apiKey 3590fb7e-7f7d-4afb-b095-43acff08c2b2

Заголовок авторизации в формате: apiKey значение_ключа

Responses

Response samples

Content type
application/json
{
  • "values": [
    ],
  • "totalCount": 0
}

Информация по тарифу поставщика

path Parameters
tariffId
required
string

Идентификатор тарифа

vendorId
required
integer <int32>

Идентификатор поставщика, которому принадлженит тариф

header Parameters
Authorization
required
string
Example: apiKey 3590fb7e-7f7d-4afb-b095-43acff08c2b2

Заголовок авторизации в формате: apiKey значение_ключа

Responses

Response samples

Content type
application/json
{
  • "tariffId": "376",
  • "tariffName": "Экономичная посылка дверь-постамат",
  • "vendorId": 8,
  • "vendorKey": "CDEK",
  • "vendorName": "СДЭК",
  • "senderContactType": 0,
  • "senderPickupPointType": 0,
  • "receiverContactType": 0,
  • "receiverPickupPointType": 0,
  • "description": "Экономичная доставка грузов и документов по России"
}

Vendors

vendors - список поставщиков, доступных для подключения пользователем

Возвращает список с информацией о поставщиках.

header Parameters
Authorization
required
string
Example: apiKey 3590fb7e-7f7d-4afb-b095-43acff08c2b2

Заголовок авторизации в формате: apiKey значение_ключа

Responses

Response samples

Content type
application/json
{}

vendors - подключение/отключение поставщика

Подключает или отключает поставщика в зависимости от установленного в запросе статуса

path Parameters
vendorKey
required
string

Ключ-идентификатор поставщика

header Parameters
Authorization
required
string
Example: apiKey 3590fb7e-7f7d-4afb-b095-43acff08c2b2

Заголовок авторизации в формате: apiKey значение_ключа

Request Body schema: application/json

Желаемый статус

enable
boolean

Включить/выключить поставщика

Responses

Request samples

Content type
application/json
{
  • "enable": true
}

Response samples

Content type
application/json
{}

vendors - описание поставщика

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

path Parameters
vendorKey
required
string

Ключ-идентификатор поставщика

header Parameters
Authorization
required
string
Example: apiKey 3590fb7e-7f7d-4afb-b095-43acff08c2b2

Заголовок авторизации в формате: apiKey значение_ключа

Responses

Response samples

Content type
application/json
{}

vendors - регистрация договора c поставщиком

Добавляет клиентский договор с поставщиком или обноляет существующий.

path Parameters
vendorKey
required
string

Ключ-идентификатор поставщика

header Parameters
Authorization
required
string
Example: apiKey 3590fb7e-7f7d-4afb-b095-43acff08c2b2

Заголовок авторизации в формате: apiKey значение_ключа

Request Body schema: application/json

Список полей договора

object or null

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

property name*
additional property
string or null

Responses

Request samples

Content type
application/json
{
  • "authorization": {
    }
}

Response samples

Content type
application/json
{}

vendors - удаление договора c поставщиком

Удаляет существующий клиентский договор

path Parameters
vendorKey
required
string

Ключ-идентификатор поставщика

header Parameters
Authorization
required
string
Example: apiKey 3590fb7e-7f7d-4afb-b095-43acff08c2b2

Заголовок авторизации в формате: apiKey значение_ключа

Responses

Response samples

Content type
application/json
{}

vendors - данные договора

Возвращает словарь полей и значений из договора с поставщиком

path Parameters
vendorKey
required
string

Ключ-идентификатор поставщика

header Parameters
Authorization
required
string
Example: apiKey 3590fb7e-7f7d-4afb-b095-43acff08c2b2

Заголовок авторизации в формате: apiKey значение_ключа

Responses

Response samples

Content type
application/json
{
  • "authorization": {
    }
}

vendors - схема

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

path Parameters
vendorKey
required
string

Ключ-идентификатор поставщика

header Parameters
Authorization
required
string
Example: apiKey 3590fb7e-7f7d-4afb-b095-43acff08c2b2

Заголовок авторизации в формате: apiKey значение_ключа

Responses

Response samples

Content type
application/json
{
  • "key": "CDEK",
  • "fields": [
    ]
}

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

path Parameters
vendorKey
required
string

Ключ-идентификатор поставщика

header Parameters
Authorization
required
string
Example: apiKey 3590fb7e-7f7d-4afb-b095-43acff08c2b2

Заголовок авторизации в формате: apiKey значение_ключа

Responses

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

path Parameters
vendorKey
required
string

Ключ-идентификатор поставщика

parameterKey
required
string

Ключ параметра настройки

header Parameters
Authorization
required
string
Example: apiKey 3590fb7e-7f7d-4afb-b095-43acff08c2b2

Заголовок авторизации в формате: apiKey значение_ключа

Responses

Создание пользовательского параметра поставщика

path Parameters
vendorKey
required
string

Ключ-идентификатор поставщика

parameterKey
required
string

Ключ параметра настройки

header Parameters
Authorization
required
string
Example: apiKey 3590fb7e-7f7d-4afb-b095-43acff08c2b2

Заголовок авторизации в формате: apiKey значение_ключа

Request Body schema:

Новое значение параметра

value
string or null

Новое значение параметра поставщика

Responses

Request samples

Content type
{
  • "value": "string"
}

Обновление пользовательского параметра поставщика

path Parameters
vendorKey
required
string

Ключ-идентификатор поставщика

parameterKey
required
string

Ключ параметра настройки

header Parameters
Authorization
required
string
Example: apiKey 3590fb7e-7f7d-4afb-b095-43acff08c2b2

Заголовок авторизации в формате: apiKey значение_ключа

Request Body schema:

Новое значение параметра

value
string or null

Новое значение параметра поставщика

Responses

Request samples

Content type
{
  • "value": "string"
}

Удаление пользовательского параметра поставщика

path Parameters
vendorKey
required
string

Ключ-идентификатор поставщика

parameterKey
required
string

Ключ параметра настройки

header Parameters
Authorization
required
string
Example: apiKey 3590fb7e-7f7d-4afb-b095-43acff08c2b2

Заголовок авторизации в формате: apiKey значение_ключа

Responses