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

versta24 Open API (v1)

Download OpenAPI specification:Download

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

OpenAPI

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

Создает заказ с переданными параметрами в статусе Черновик (Draft) и передает его поставщику на выполнение или возвращает возможные вариант доставки.
Для того чтобы заказ был сразу передан поставщику, необходимо указать поля VendorId и VendorUrgentTypeId в DeliveryOptions
Если данные поля не заполнены, то возвращается список возможных вариантов доставки (DeliveryOptions)
После выбора варианта и для передачи заказа поставщику, необходимо вызывать метод PushToVendor.

Request Body schema: application/json

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

callCourier
boolean

Нужен ли вызов. По умолчанию - да

required
object

Информация об отправителе. Необходимо заполнять при создании заказа

required
object

Информация о получателе. Необходимо заполнять при создании заказа

object (SellerModel)

Информация об истинном продавце. Необходимо заполнять при создании заказа интернет-магазина

required
object (CargoDescModel)

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

required
object (OrderDeliveryOptionsModel)

DeliveryOptionMode - параметры условий доставки и забора отправления

Array of objects or null (OrderServiceModel)

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

object (AdditionalServicesModel)

additionalServicesModel - дополнительные сервисы

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

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

emergencyEmail
string or null

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

parentOrderId
string or null

Идентификатор родительского заказа (Верста). Необязателен.

apiKey
required
string non-empty

apiKey - ключ клиента

Responses

Request samples

Content type
application/json
{
  • "callCourier": true,
  • "sender": {
    },
  • "receiver": {
    },
  • "seller": {
    },
  • "cargo": {
    },
  • "deliveryOptions": {
    },
  • "services": [
    ],
  • "additionalServices": {
    },
  • "companyId": null,
  • "project": "Доставка товаров",
  • "department": "Логистика",
  • "customerOrderId": "MX123456",
  • "customerOrderIdDontCheck": true,
  • "customerActNumber": "A-654",
  • "receiverDeliveryCharge": 100,
  • "receiverDeliveryChargeVatRate": 0,
  • "emergencyEmail": "emergency@email.com",
  • "parentOrderId": "VSXXX-XXX-XXX-XXX",
  • "apiKey": "apiKey"
}

Response samples

Content type
application/json
{
  • "orderId": "VSXXX-XXX-XXX-XXX",
  • "errors": [
    ]
}

createMany - Создание массива заказов

Создает заказы с переданными параметрами в статусе Черновик (Draft) и передает их поставщику(-ам) на выполнение или возвращает возможные варианты доставки.
Для того чтобы заказ был сразу передан поставщику, необходимо указать поля VendorId и VendorUrgentTypeId в DeliveryOptions
Если данные поля не заполнены, то возвращается список возможных вариантов доставки (DeliveryOptions)
После выбора варианта и для передачи заказа поставщику, необходимо вызывать метод PushToVendor.

Request Body schema: application/json

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

Array
callCourier
boolean

Нужен ли вызов. По умолчанию - да

required
object

Информация об отправителе. Необходимо заполнять при создании заказа

required
object

Информация о получателе. Необходимо заполнять при создании заказа

object (SellerModel)

Информация об истинном продавце. Необходимо заполнять при создании заказа интернет-магазина

required
object (CargoDescModel)

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

required
object (OrderDeliveryOptionsModel)

DeliveryOptionMode - параметры условий доставки и забора отправления

Array of objects or null (OrderServiceModel)

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

object (AdditionalServicesModel)

additionalServicesModel - дополнительные сервисы

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

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

emergencyEmail
string or null

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

parentOrderId
string or null

Идентификатор родительского заказа (Верста). Необязателен.

apiKey
required
string non-empty

apiKey - ключ клиента

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

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

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

Request Body schema: application/json
vendorId
required
integer <int32>

Идентификатор вендора, которому необходимо передать заказ. Этот идентификатор необходимо взять из вариантов доставки (DeliveryOptions)

vendorUrgentTypeId
required
string non-empty

Идентификатор срочности поставщика. Этот идентификатор необходимо взять из вариантов доставки (DeliveryOptions)

autoChangeTakeDate
boolean

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

orderId
required
string non-empty

Номер заказа Versta

orderKey
string or null

Ключ доступа к заказу

apiKey
required
string non-empty

apiKey - ключ клиента

Responses

Request samples

Content type
application/json
{
  • "vendorId": 0,
  • "vendorUrgentTypeId": "4",
  • "autoChangeTakeDate": true,
  • "orderId": "\n \"VSXXX-XXX-XXX\"\n ",
  • "orderKey": "key",
  • "apiKey": "apiKey"
}

Response samples

Content type
application/json
{
  • "orderPushResult": 0,
  • "orderId": "V24X-XXX-XXX-XXX",
  • "orderKey": "xxxxxxx",
  • "vendorInvoiceNum": "62377725-23",
  • "vendorPickupNum": "4562389-78",
  • "price": 200,
  • "planDeliveryDate": "2020-04-18T00:00:00",
  • "vendorInfo": {},
  • "status": 5,
  • "statusName": "Передан поставщику",
  • "emergencyEmail": "emergency@email.com"
}

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

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

Request Body schema: application/json
ordersId
Array of strings or null

Перечень идентификаторов заказов Versta, по которым нужно вызвать курьера Если указан, следующие параметры игнорируются: OrderPlaceDate SenderCityId, SenderAddress, VendorsId

orderPlaceDate
string or null

Фильтр заказов по дата размещения в Versta. Указывается в формате yyyy-MM-dd. По умолчанию, текущая дата. Обязательно, если не указан OrdersId

senderCityId
string or null

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

senderAddress
string or null

Фильтр заказов по адресу отправителя. Должен полностью совпадать с адресом, указанном в заказах!!!

vendorsId
Array of integers or null <int32>

Фильтр по поставщикам заказов. Идентификатор поставщика указан в параметре VendorInfo.VendorId ответа на запрос create

takeDate
string or null

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

timeFrom
string <date-span>

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

timeTo
string <date-span>

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

apiKey
required
string non-empty

apiKey - ключ клиента

Responses

Request samples

Content type
application/json
{
  • "ordersId": [
    ],
  • "orderPlaceDate": "2020-04-20",
  • "senderCityId": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5",
  • "senderAddress": "ул Сухонская, д 11",
  • "vendorsId": [
    ],
  • "takeDate": "2020-04-21",
  • "timeFrom": "12:00",
  • "timeTo": "15:00",
  • "apiKey": "apiKey"
}

Response samples

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

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

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

Request Body schema: application/json
includePdf
string or null

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

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

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

invoiceCopy
integer <int32>

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

printInvoice
boolean

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

printInsurance
boolean

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

printMarks
boolean

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

docsToPrint
integer <int32> (ApiStorageFileTypes)
Enum: 0 1 2 4 8 16 32 64 128 256
orderId
required
string non-empty

Номер заказа Versta

orderKey
string or null

Ключ доступа к заказу

apiKey
required
string non-empty

apiKey - ключ клиента

Responses

Request samples

Content type
application/json
{
  • "includePdf": "aW5jbHVkZSBwZGYgYmFzZTY0IHN0cmluZw==",
  • "includePosition": 0,
  • "includeCopy": 0,
  • "invoiceCopy": 0,
  • "printInvoice": true,
  • "printInsurance": true,
  • "printMarks": true,
  • "docsToPrint": 0,
  • "orderId": "\n \"VSXXX-XXX-XXX\"\n ",
  • "orderKey": "key",
  • "apiKey": "apiKey"
}

Response samples

Content type
application/json
[
  • {
    }
]

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

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

Request Body schema: application/json

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

companyId
integer or null <int32>

Идентификатор компании, для которой рассчитываются цены. Если идентификатор не задан, то берется компания, привязанные к ключу API

showVendorsOptions
boolean

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

required
object (RoutePointModel)

Описание точки маршрута

required
object (RoutePointModel)

Описание точки маршрута

required
object (CargoDescModel)

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

required
object (OrderDeliveryOptionsModel)

DeliveryOptionMode - параметры условий доставки и забора отправления

Array of objects or null (OrderServiceModel)

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

object (AdditionalServicesModel)

additionalServicesModel - дополнительные сервисы

apiKey
required
string non-empty

apiKey - ключ клиента

Responses

Request samples

Content type
application/json
{
  • "companyId": 0,
  • "showVendorsOptions": true,
  • "sender": {
    },
  • "receiver": {
    },
  • "cargo": {
    },
  • "deliveryOptions": {
    },
  • "services": [
    ],
  • "additionalServices": {
    },
  • "apiKey": "apiKey"
}

Response samples

Content type
application/json
{
  • "orderId": "string",
  • "options": [
    ]
}

calcMany - расчет стоимости массива заказов

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

Request Body schema: application/json

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

Array
customerOrderId
string or null

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

companyId
integer or null <int32>

Идентификатор компании, для которой рассчитываются цены. Если идентификатор не задан, то берется компания, привязанные к ключу API

showVendorsOptions
boolean

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

required
object (RoutePointModel)

Описание точки маршрута

required
object (RoutePointModel)

Описание точки маршрута

required
object (CargoDescModel)

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

required
object (OrderDeliveryOptionsModel)

DeliveryOptionMode - параметры условий доставки и забора отправления

Array of objects or null (OrderServiceModel)

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

object (AdditionalServicesModel)

additionalServicesModel - дополнительные сервисы

apiKey
required
string non-empty

apiKey - ключ клиента

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "hasErrors": true,
  • "options": [
    ],
  • "total": {
    }
}

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

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

Request Body schema: application/json
callCourier
boolean

Нужен ли вызов. По умолчанию - да

required
object

Информация об отправителе. Необходимо заполнять при создании заказа

required
object

Информация о получателе. Необходимо заполнять при создании заказа

object (SellerModel)

Информация об истинном продавце. Необходимо заполнять при создании заказа интернет-магазина

required
object (CargoDescModel)

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

required
object (OrderDeliveryOptionsModel)

DeliveryOptionMode - параметры условий доставки и забора отправления

Array of objects or null (OrderServiceModel)

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

object (AdditionalServicesModel)

additionalServicesModel - дополнительные сервисы

companyId
integer or null <int32>

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

project
string or null

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

department
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

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

emergencyEmail
string or null

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

parentOrderId
string or null

Идентификатор родительского заказа (Верста). Необязателен.

orderId
required
string non-empty

Номер заказа Versta

orderKey
string or null

Ключ доступа к заказу

apiKey
required
string non-empty

apiKey - ключ клиента

customerOrderId
any

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

Responses

Request samples

Content type
application/json
{
  • "callCourier": true,
  • "sender": {
    },
  • "receiver": {
    },
  • "seller": {
    },
  • "cargo": {
    },
  • "deliveryOptions": {
    },
  • "services": [
    ],
  • "additionalServices": {
    },
  • "companyId": null,
  • "project": "Доставка товаров",
  • "department": "Логистика",
  • "customerOrderIdDontCheck": true,
  • "customerActNumber": "A-654",
  • "receiverDeliveryCharge": 100,
  • "receiverDeliveryChargeVatRate": 0,
  • "emergencyEmail": "emergency@email.com",
  • "parentOrderId": "VSXXX-XXX-XXX-XXX",
  • "orderId": "\n \"VSXXX-XXX-XXX\"\n ",
  • "orderKey": "key",
  • "apiKey": "apiKey",
  • "customerOrderId": "MX123456"
}

Response samples

Content type
application/json
{
  • "orderInfo": {
    },
  • "callCourier": true,
  • "sender": {
    },
  • "receiver": {
    },
  • "seller": {
    },
  • "cargo": {
    },
  • "deliveryOptions": {
    },
  • "services": [
    ],
  • "additionalServices": {
    },
  • "companyId": null,
  • "project": "Доставка товаров",
  • "department": "Логистика",
  • "customerOrderId": "MX123456",
  • "customerOrderIdDontCheck": true,
  • "customerActNumber": "A-654",
  • "receiverDeliveryCharge": 100,
  • "receiverDeliveryChargeVatRate": 0,
  • "emergencyEmail": "emergency@email.com",
  • "orderProperties": [
    ],
  • "parentOrderId": "VSXXX-XXX-XXX-XXX"
}

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

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

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

Номер заказа Versta

orderKey
string or null

Ключ доступа к заказу

apiKey
required
string non-empty

apiKey - ключ клиента

Responses

Request samples

Content type
application/json
{
  • "orderId": "\n \"VSXXX-XXX-XXX\"\n ",
  • "orderKey": "key",
  • "apiKey": "apiKey"
}

Response samples

Content type
application/json
{
  • "orderInfo": {
    },
  • "callCourier": true,
  • "sender": {
    },
  • "receiver": {
    },
  • "seller": {
    },
  • "cargo": {
    },
  • "deliveryOptions": {
    },
  • "services": [
    ],
  • "additionalServices": {
    },
  • "companyId": null,
  • "project": "Доставка товаров",
  • "department": "Логистика",
  • "customerOrderId": "MX123456",
  • "customerOrderIdDontCheck": true,
  • "customerActNumber": "A-654",
  • "receiverDeliveryCharge": 100,
  • "receiverDeliveryChargeVatRate": 0,
  • "emergencyEmail": "emergency@email.com",
  • "orderProperties": [
    ],
  • "parentOrderId": "VSXXX-XXX-XXX-XXX"
}

getOrders - Получить заказы по фильтрам

Возвращает полную информацию о заказах по переданным фильтрам

Request Body schema: application/json
ordersId
Array of strings or null

Перечень идентификаторов заказов Versta Если указан, остальные фильтры игнорируются

createDateFrom
string or null

Фильтр по дате создания заказа (начальная дата). Указывается дата в формате yyyy-MM-dd

createDateTo
string or null

Фильтр по дате создания заказа (конечная дата). Указывается дата в формате yyyy-MM-dd

statuses
Array of integers or null <int32> (OpenApiOrderStatus)
Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 30 31 32 50 51 80 90 91 92 93 95 97 98 99

Фильтр по статусу заказа

apiKey
required
string non-empty

apiKey - ключ клиента

Responses

Request samples

Content type
application/json
{
  • "ordersId": [
    ],
  • "createDateFrom": "2020-04-18",
  • "createDateTo": "2020-04-20",
  • "statuses": [
    ],
  • "apiKey": "apiKey"
}

Response samples

Content type
application/json
{
  • "orderInfo": {
    },
  • "callCourier": true,
  • "sender": {
    },
  • "receiver": {
    },
  • "seller": {
    },
  • "cargo": {
    },
  • "deliveryOptions": {
    },
  • "services": [
    ],
  • "additionalServices": {
    },
  • "companyId": null,
  • "project": "Доставка товаров",
  • "department": "Логистика",
  • "customerOrderId": "MX123456",
  • "customerOrderIdDontCheck": true,
  • "customerActNumber": "A-654",
  • "receiverDeliveryCharge": 100,
  • "receiverDeliveryChargeVatRate": 0,
  • "emergencyEmail": "emergency@email.com",
  • "orderProperties": [
    ],
  • "parentOrderId": "VSXXX-XXX-XXX-XXX"
}

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

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

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

Номер заказа Versta

orderKey
string or null

Ключ доступа к заказу

apiKey
required
string non-empty

apiKey - ключ клиента

Responses

Request samples

Content type
application/json
{
  • "orderId": "\n \"VSXXX-XXX-XXX\"\n ",
  • "orderKey": "key",
  • "apiKey": "apiKey"
}

Response samples

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

cancel - отмена заказа

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

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

Номер заказа Versta

orderKey
string or null

Ключ доступа к заказу

apiKey
required
string non-empty

apiKey - ключ клиента

Responses

Request samples

Content type
application/json
{
  • "orderId": "\n \"VSXXX-XXX-XXX\"\n ",
  • "orderKey": "key",
  • "apiKey": "apiKey"
}

Response samples

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

getPickupPoints - список точек выдачи

Возвращает список точек выдачи поставщиков

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

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

cityId
required
string non-empty

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

vendorId
integer or null <int32>

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

cargoType
integer <int32> (ApiCargoTypes)
Enum: 1 2 4 8 32 64 128 256

Тип груза для перевозки:
1 - Docs - Документы
2 - CargoRegular - Обычный груз
4 - CargoDanger - Опасный груз (к опасным грузам относятся грузы определенной категории. см. правила перевозки) 8 - CargoOversize - (устаревшее) Негабаритный груз - груз в котором одно из мест по сумме трех измерений первышает 270 см или вес превышает 80 кг. Вместо этого признака нужно передавать габариты и вес груза. Под каждого поставщика данный параметр определяется автоматически по габаритам. Сейчас ни на что не влияет
32 - CargoFragile - Хрупкий груз - груз при перевозке которого должны соблюдаться специальные условия размещения (см. правила перевозки)
64 - OnlineStoreOrder - Посылка интернет-магазина

Array of objects or null (CargoItemModel)

Массив с описанием параметров мест. Необязательный параметр для заполнения. Если данный параметр не указан, то возвращается весь список точек выдачи без фильтра по максимальным габаратам и суммарному весу. Если указан данный параметр необходима указать тип груза CargoType

withPriceCalc
boolean

Если указано true, то к каждой точке также считаются варианты доставки (это увеличивает время работы метода) Данная опция является эксперементальной. По-умолчанию - false

weight
number <double>

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

apiKey
required
string non-empty

apiKey - ключ клиента

Responses

Request samples

Content type
application/json
{
  • "country": "RU",
  • "cityId": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5",
  • "vendorId": 8,
  • "cargoType": 1,
  • "cargoItems": [
    ],
  • "withPriceCalc": false,
  • "weight": 1,
  • "apiKey": "apiKey"
}

Response samples

Content type
application/json
{}

getOrderStatuses - список актуальных статусов

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

Request Body schema: application/json
Array of objects or null (OrderStatusInfoModel)
apiKey
required
string non-empty

apiKey - ключ клиента

Responses

Request samples

Content type
application/json
{
  • "orderStatusesInfo": [
    ],
  • "apiKey": "apiKey"
}

Response samples

Content type
application/json
{
  • "orderStatusesInfo": [
    ],
  • "apiKey": "apiKey"
}