SelSup Developers

Публичный API · API Reference

Доставка

Методы раздела «Доставка»: точные маршруты, параметры, тела запросов и раскрываемые структуры ответов.

18 методов/api/deliveryСтабильныйМашинное описание ↗
{ }

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

/api/delivery

Готовые сценарии

Готовые сценарии

01

Начать работу с разделом «Доставка»

Используйте отдельный API-токен и сначала проверяйте операции чтения на тестовых данных.

  1. Сохраните токен на серверной стороне и передавайте его в заголовке Authorization.
  2. Проверьте обязательные параметры и раскройте структуру запроса или ответа.
  3. Обрабатывайте HTTP-статус и стабильное поле error в прикладных ошибках.

Модель данных

Структуры данных раздела

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

AdditionalDeliveryServiceDto3 полей
codestring

Поле code.

namestring

Поле name.

descriptionstring

Поле description.

Address15 полей
idinteger · int32

Поле id.

postCodestring

Поле postCode.

countryCountry

Поле country.

regionRegion

Поле region.

regionIdinteger · int32

Поле regionId.

streetstring

Поле street.

housestring

Поле house.

districtstring

Поле district.

citystring

Поле city.

localitystring

Поле locality.

buildingstring

Поле building.

flatstring

Поле flat.

shortstring

Поле short.

addressIdAddress

Поле addressId.

fullstring

Поле full.

Country6 полей
countryIdinteger · int32

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

namestring

Название страны

code2string

Двухбуквенный код страны

code3string

Трехбуквенный код страны

namesobject

Поле names.

printNamestring

Поле printName.

DeliveryTariff13 полей
deliverySumnumber · float

Стоимость доставки

periodMininteger · int32

Минимальное время доставки (в рабочих днях)

periodMaxinteger · int32

Максимальное время доставки (в рабочих днях)

calendarMininteger · int32

Минимальное время доставки (в календарных днях)

calendarMaxinteger · int32

Максимальное время доставки (в календарных днях)

tariffIdinteger · int32

Уникальный идентификатор

shippingServicestring

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

tariffCodeinteger · int32

Код тарифа

externalTariffCodestring

Внешний строковый идентификатор тарифа или предложения

tariffNamestring

Название тарифа

tariffDescriptionstring

Описание тарифа

deliveryModeinteger · int32

Режим доставки

additionalServicesAdditionalDeliveryServiceDto[]

Дополнительные услуги к тарифу

Organization33 полей
idinteger · int64

Идентификатор организации. Проставляется автоматически

read-only
namestring

Полное наименование организации

Обязательно
shortNamestring

Поле shortName.

taxTypestring

Система налогооблажения

taxRateinteger · int32

Ставка налога, если она отличается от стандартной

taxNdsinteger · int32

Ставка налога, если она отличается от стандартной

inputTaxNdsinteger · int32

Ставка входящего НДС

outputTaxNdsinteger · int32

Ставка исходящего НДС

enableNewTaxCalculationboolean

Включить расчет налогов по новым правилам

useNdsCostPriceboolean

Учитывать входящий НДС в себестоимости

innstring

ИНН

Обязательно
kppstring

КПП. Проставляется только для ООО

bankstring

Название банка

bikstring

БИК счета организации

corrBillstring

Номер корреспондентского счета

billNumberstring

Номер счета организации

stampPathstring

Ссылка на изображение печати организации

read-only
stampUrlstring

Ссылка на изображение печати организации

read-only
stampSizeinteger · int32

Размер в байтах изображения печати организации

read-only
stampWidthinteger · int32

Ширина изображения печати организации

read-only
stampHeightinteger · int32

Высота изображения печати организации

read-only
signaturePathstring

Фото подписи директора организации

read-only
signatureUrlstring

Фото подписи директора организации

read-only
signatureSizeinteger · int32

Размер файла в байтах подписи директора организации

read-only
signatureWidthinteger · int32

Ширина изображения подписи директора

read-only
signatureHeightinteger · int32

Высота изображения подписи директора

read-only
ipPersonPerson

Руководитель организации или ИП

formstring

Организационно правовая форма

Обязательно
ipboolean

Поле ip.

clientIdinteger · int64

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

read-only
addressAddress

Адресс организации

phoneNumberstring

Номер телефона

addressFullstring

Полный адрес

read-only
Person14 полей
personIdinteger · int64

Поле personId.

read-only
firstNamestring

Имя сотрудника

Обязательно
lastNamestring

Фамилия сотрудника

Обязательно
surNamestring

Отчество сотрудника

clientIdinteger · int64

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

read-only
positionPersonPosition

Должность сотрудника

Обязательно
versionIdinteger · int64

Поле нужно передавать при изменении,для предотвращения одновременной перезаписи

read-only
createdUserstring

Проставляется автоматически. Пользователь создавший сотрудника

read-only
createdDatestring · date-time

Проставляется автоматически. Дата создания сотрудника

read-only
deletedboolean

Признак удаления сотрудника

read-only
userIdinteger · int32

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

read-only
hasChangesboolean

Поле hasChanges.

fullNamestring

Полные ФИО

read-only
shortNamestring

Фамилия и инициалы

read-only
PersonPosition7 полей
idinteger · int64

Идентификатор должности. Проставляется автоматически

read-only
namestring

Название должности

Обязательно
deletedboolean

Признак удаления должности

read-only
clientIdinteger · int64

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

read-only
defaultJobIdinteger · int64

Работа по умолчанию для должности

createdUserstring

Пользователь, который создал должность

read-only
createdDatestring · date-time

Дата создания должности

read-only
Region4 полей
regionIdinteger · int32

Поле regionId.

countryIdinteger · int32

Поле countryId.

namestring

Поле name.

regionSynonymsRegionSynonym[]

Поле regionSynonyms.

RegionSynonym4 полей
idinteger · int64

Поле id.

regionIdinteger · int64

Поле regionId.

synonymstring

Поле synonym.

servicestring

Поле service.

WarehouseDelivery15 полей
warehouseDeliveryIdinteger · int64

Поле warehouseDeliveryId.

pointstring

Поле point.

servicestring

Поле service.

warehouseIdinteger · int64

Поле warehouseId.

organizationIdinteger · int64

Поле organizationId.

tariffPrioritystring

Поле tariffPriority.

prioritiesobject

Поле priorities.

priorityByModeboolean

Поле priorityByMode.

additionalServicesstring

Поле additionalServices.

sendZeroPriceboolean

Поле sendZeroPrice.

fakeNamestring

Поле fakeName.

hideOrganizationboolean

Поле hideOrganization.

sellerOrganizationIdinteger · int64

Поле sellerOrganizationId.

organizationOrganization

Поле organization.

additionalServiceForTariffDeliveryTariff

Поле additionalServiceForTariff.

FileExportColumn5 полей
idinteger · int64

ID записи

fileExportIdinteger · int64

ID конфигурации экспорта

columnNamestring

Название столбца

columnOrderinteger · int32

Порядок столбца в файле

isEnabledboolean

Включен ли столбец для экспорта

TmsTask25 полей
idinteger · int64

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

read-only
statusstring

Текущий статус задачи

read-only
typestring

Тип задачи

read-only
namestring

Данные задачи в json - могут быть пустыми

clientIdinteger · int64

Поле clientId.

entityIdinteger · int64

Сущность, к которой относится задача

progressinteger · int32

Прогресс выполнения задачи в процентах

processedQuantityinteger · int32

Количество обработанных записей задачи

organizationIdinteger · int64

Организация задачи, может быть 0, если не зависит от организации

priorityinteger · int32

Приоритет задачи - чем выше тем быстрее задача запустится

propertiesstring

Параметры задачи

messagestring

Сообщение с результатом выполнения задачи

messageParamsstring

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

createdDatestring · date-time

Дата добавления задачи в очередь

startDatestring · date-time

Дата запуска задачи

finishDatestring · date-time

Дата завершения задачи

urlstring

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

inputFileUrlstring

Ссылка на загруженный файл

retryNumberinteger · int32

Счётчик перезапуска задачи.

userIdinteger · int32

Пользователь запустивший задачу

retryDatestring · date-time

Запланированная дата перезапуска

debugboolean

Запуск задачи в режиме отладки с большим логированием

forcedStartboolean

Ручной запуск задачи

servicestring

Сервис в рамках которого выполняется задача

langstring

Язык на котором сейчас запущена таска

CalculatedDeliveryTariff11 полей
deliverySumnumber · float

Стоимость доставки

periodMininteger · int32

Минимальное время доставки (в рабочих днях)

periodMaxinteger · int32

Максимальное время доставки (в рабочих днях)

calendarMininteger · int32

Минимальное время доставки (в календарных днях)

calendarMaxinteger · int32

Максимальное время доставки (в календарных днях)

servicesobject

Поле services.

locationToCodestring

Поле locationToCode.

locationFromCodestring

Поле locationFromCode.

tariffCodeinteger · int32

Поле tariffCode.

deliveryModeToOrderCreateinteger · int32

Поле deliveryModeToOrderCreate.

deliveryModeListinteger[]

Поле deliveryModeList.

DeliveryServiceData10 полей
idinteger · int64

Поле id.

tokenExpiredDatestring · date-time

Поле tokenExpiredDate.

servicestring

Поле service.

serviceClientIdstring

Поле serviceClientId.

serviceSecretDeliveryServiceData

Поле serviceSecret.

clientIdinteger · int64

Поле clientId.

organizationIdinteger · int64

Поле organizationId.

updateTokenboolean

Поле updateToken.

hasTokenboolean

Поле hasToken.

hasSecretboolean

Поле hasSecret.

DeliveryRegion2 полей
namestring

Поле name.

idstring

Поле id.

DeliveryPoint11 полей
namestring

Поле name.

locationDeliveryPointsLocation

Поле location.

addressstring

Поле address.

addressCommentstring

Поле addressComment.

notestring

Поле note.

workTimestring

Поле workTime.

phonesPhone[]

Поле phones.

zipCodestring

Поле zipCode.

codestring

Поле code.

emailstring

Поле email.

sitestring

Поле site.

DeliveryPointsLocation12 полей
addressstring

Строка адреса

codeinteger · int32

Код населенного пункта СДЭК

postal_codestring

Почтовый индекс

country_codestring

Код страны в формате ISO_3166-1_alpha-2

citystring

Название города

fias_guidstring

Уникальный идентификатор ФИАС населенного пункта

longitudenumber · float

Долгота центра населенного пункта

latitudenumber · float

Широта центра населенного пункта

regionstring

Название региона населенного пункта

region_codeinteger · int32

Код региона СДЭК

address_fullstring

Строка адреса

city_codestring

Код населенного пункта СДЭК

Phone2 полей
numberstring

Номер телефонаДолжен передаваться в международном формате: код страны (для России +7) и сам номер (10 и более цифр)

additionalstring

Дополнительная информация (добавочный номер)

DeliveryCity2 полей
namestring

Поле name.

idstring

Поле id.

AddressDto8 полей
addressstring

Адрес найденного объекта

postalCodestring

Индекс почтового отделения

regionstring

Область/Край

localitystring

Населённый пункт

streetstring

Улица

housestring

Отдельный дом

longitudenumber · double

Долгота

latitudenumber · double

Широта

Контракт ошибок

Как API возвращает прикладные ошибки

Код ошибки одинаков для всех локалей, а текст для пользователя переводится сервером. Поэтому бизнес-логику стройте по error, а localMessage используйте только для отображения.

error

Стабильный машинный код ошибки для логики интеграции.

localMessage

Готовое сообщение на языке пользователя API-токена.

params

Значения

Язык localMessage определяется полем lang пользователя, которому принадлежит API-токен. Язык страницы документации и заголовок Accept-Language его не переключают; если язык пользователя не указан, используется русский.

RUПользователь с локалью ru
{
  "error": "error_brand_already_exists",
  "localMessage": "Бренд Base уже существует",
  "params": {
    "name": "Base"
  }
}
ENПользователь с локалью en
{
  "error": "error_brand_already_exists",
  "localMessage": "Brand Base already exists",
  "params": {
    "name": "Base"
  }
}

Методы

Методы

POST

Обновление статуса из сервиса доставки

/api/delivery/updateDeliveryOrder
Токен с правами записи

Обновление статуса из сервиса доставки.

Параметры запроса

ПолеТипОбязательноОписание
orderId integer · int64 Да Идентификатор заказа
curl --request POST 'https://api.selsup.ru/api/delivery/updateDeliveryOrder?orderId=1001' \
  --header 'Authorization: YOUR_API_TOKEN'

Успешный ответ

200

Тело ответа пустое.

Ошибки3

Прикладные ошибки обычно возвращаются как JSON с полями error, localMessage и params. Ориентируйтесь на error; локализованный текст может меняться. Как API возвращает прикладные ошибки ↑

401auth_required
Требуется авторизация

Заголовок Authorization отсутствует, пуст или содержит недействительный токен.

400error_access_denied
Недостаточно прав

Токен существует, но его роль не позволяет выполнить операцию.

500error_unknown
Непредвиденная ошибка

Внутренняя ошибка. Сохраните время запроса и обратитесь в поддержку, не повторяя мутацию вслепую.

POST

Сохранить пункт доставки со склада

/api/delivery/storeWarehouseDelivery
Токен с правами записи

Сохранить пункт доставки со склада.

Тело запроса

application/json
Поля объектаWarehouseDelivery
ПолеТипОбязательноОписание
warehouseDeliveryId integer · int64 Нет Поле warehouseDeliveryId.
point string Нет Поле point.
service stringCDEK, OWN_DELIVERY, POST, BOXBERRY, DPD, YANDEX, DOSTAVISTA, DELLIN, PEC, YANDEX_EXPRESS, FIVE_POST Нет Поле service.
warehouseId integer · int64 Нет Поле warehouseId.
organizationId integer · int64 Нет Поле organizationId.
tariffPriority string Нет Поле tariffPriority.
priorities object Нет Поле priorities.
priorityByMode boolean Нет Поле priorityByMode.
additionalServices string Нет Поле additionalServices.
sendZeroPrice boolean Нет Поле sendZeroPrice.
fakeName string Нет Поле fakeName.
hideOrganization boolean Нет Поле hideOrganization.
sellerOrganizationId integer · int64 Нет Поле sellerOrganizationId.
organization Organization Нет Поле organization.
Поля объекта Organization
ПолеТипОбязательноОписание
id integer · int64 Нет Идентификатор организации. Проставляется автоматически
name string Да Полное наименование организации
shortName string Нет Поле shortName.
taxType stringYSN, YSN_CONSUMPTION, AUSN, AUSN_CONSUMPTION, OSNO, SELF_EMPLOYED Нет Система налогооблажения
taxRate integer · int32 Нет Ставка налога, если она отличается от стандартной
taxNds integer · int32 Нет Ставка налога, если она отличается от стандартной
inputTaxNds integer · int32 Нет Ставка входящего НДС
outputTaxNds integer · int32 Нет Ставка исходящего НДС
enableNewTaxCalculation boolean Нет Включить расчет налогов по новым правилам
useNdsCostPrice boolean Нет Учитывать входящий НДС в себестоимости
inn string Да ИНН
kpp string Нет КПП. Проставляется только для ООО
bank string Нет Название банка
bik string Нет БИК счета организации
corrBill string Нет Номер корреспондентского счета
billNumber string Нет Номер счета организации
stampPath string Нет Ссылка на изображение печати организации
stampUrl string Нет Ссылка на изображение печати организации
stampSize integer · int32 Нет Размер в байтах изображения печати организации
stampWidth integer · int32 Нет Ширина изображения печати организации
stampHeight integer · int32 Нет Высота изображения печати организации
signaturePath string Нет Фото подписи директора организации
signatureUrl string Нет Фото подписи директора организации
signatureSize integer · int32 Нет Размер файла в байтах подписи директора организации
signatureWidth integer · int32 Нет Ширина изображения подписи директора
signatureHeight integer · int32 Нет Высота изображения подписи директора
ipPerson Person Нет Руководитель организации или ИП
Поля объекта Person
ПолеТипОбязательноОписание
personId integer · int64 Нет Поле personId.
firstName string Да Имя сотрудника
lastName string Да Фамилия сотрудника
surName string Нет Отчество сотрудника
clientId integer · int64 Нет Идентификатор клиента
position PersonPosition Да Должность сотрудника
versionId integer · int64 Нет Поле нужно передавать при изменении,для предотвращения одновременной перезаписи
createdUser string Нет Проставляется автоматически. Пользователь создавший сотрудника
createdDate string · date-time Нет Проставляется автоматически. Дата создания сотрудника
deleted boolean Нет Признак удаления сотрудника
userId integer · int32 Нет Связь сотрудника с пользователем
hasChanges boolean Нет Поле hasChanges.
fullName string Нет Полные ФИО
shortName string Нет Фамилия и инициалы
form stringOOO, IP, SELF_EMPLOYED Да Организационно правовая форма
ip boolean Нет Поле ip.
clientId integer · int64 Нет Идентификатор клиента
address Address Нет Адресс организации
Поля объекта Address
ПолеТипОбязательноОписание
id integer · int32 Нет Поле id.
postCode string Нет Поле postCode.
country Country Нет Поле country.
region Region Нет Поле region.
regionId integer · int32 Нет Поле regionId.
street string Нет Поле street.
house string Нет Поле house.
district string Нет Поле district.
city string Нет Поле city.
locality string Нет Поле locality.
building string Нет Поле building.
flat string Нет Поле flat.
short string Нет Поле short.
addressId Address Нет Поле addressId.
full string Нет Поле full.
phoneNumber string Нет Номер телефона
addressFull string Нет Полный адрес
additionalServiceForTariff DeliveryTariff Нет Поле additionalServiceForTariff.
Поля объекта DeliveryTariff
ПолеТипОбязательноОписание
deliverySum number · float Нет Стоимость доставки
periodMin integer · int32 Нет Минимальное время доставки (в рабочих днях)
periodMax integer · int32 Нет Максимальное время доставки (в рабочих днях)
calendarMin integer · int32 Нет Минимальное время доставки (в календарных днях)
calendarMax integer · int32 Нет Максимальное время доставки (в календарных днях)
tariffId integer · int32 Нет Уникальный идентификатор
shippingService stringCDEK, OWN_DELIVERY, POST, BOXBERRY, DPD, YANDEX, DOSTAVISTA, DELLIN, PEC, YANDEX_EXPRESS, FIVE_POST Нет Сервис доставки, которому принадлежит данный тариф
tariffCode integer · int32 Нет Код тарифа
externalTariffCode string Нет Внешний строковый идентификатор тарифа или предложения
tariffName string Нет Название тарифа
tariffDescription string Нет Описание тарифа
deliveryMode integer · int320, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 Нет Режим доставки
additionalServices AdditionalDeliveryServiceDto[] Нет Дополнительные услуги к тарифу
Структура элемента массива AdditionalDeliveryServiceDto
ПолеТипОбязательноОписание
code string Нет Поле code.
name string Нет Поле name.
description string Нет Поле description.
curl --request POST 'https://api.selsup.ru/api/delivery/storeWarehouseDelivery' \
  --header 'Authorization: YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "warehouseDeliveryId": 1001,
  "point": "string",
  "service": "CDEK",
  "warehouseId": 1001,
  "organizationId": 1001,
  "tariffPriority": "string"
}'

Успешный ответ

200
Поля объекта WarehouseDelivery
ПолеТипОбязательноОписание
warehouseDeliveryId integer · int64 Нет Поле warehouseDeliveryId.
point string Нет Поле point.
service stringCDEK, OWN_DELIVERY, POST, BOXBERRY, DPD, YANDEX, DOSTAVISTA, DELLIN, PEC, YANDEX_EXPRESS, FIVE_POST Нет Поле service.
warehouseId integer · int64 Нет Поле warehouseId.
organizationId integer · int64 Нет Поле organizationId.
tariffPriority string Нет Поле tariffPriority.
priorities object Нет Поле priorities.
priorityByMode boolean Нет Поле priorityByMode.
additionalServices string Нет Поле additionalServices.
sendZeroPrice boolean Нет Поле sendZeroPrice.
fakeName string Нет Поле fakeName.
hideOrganization boolean Нет Поле hideOrganization.
sellerOrganizationId integer · int64 Нет Поле sellerOrganizationId.
organization Organization Нет Поле organization.
Поля объекта Organization
ПолеТипОбязательноОписание
id integer · int64 Нет Идентификатор организации. Проставляется автоматически
name string Да Полное наименование организации
shortName string Нет Поле shortName.
taxType stringYSN, YSN_CONSUMPTION, AUSN, AUSN_CONSUMPTION, OSNO, SELF_EMPLOYED Нет Система налогооблажения
taxRate integer · int32 Нет Ставка налога, если она отличается от стандартной
taxNds integer · int32 Нет Ставка налога, если она отличается от стандартной
inputTaxNds integer · int32 Нет Ставка входящего НДС
outputTaxNds integer · int32 Нет Ставка исходящего НДС
enableNewTaxCalculation boolean Нет Включить расчет налогов по новым правилам
useNdsCostPrice boolean Нет Учитывать входящий НДС в себестоимости
inn string Да ИНН
kpp string Нет КПП. Проставляется только для ООО
bank string Нет Название банка
bik string Нет БИК счета организации
corrBill string Нет Номер корреспондентского счета
billNumber string Нет Номер счета организации
stampPath string Нет Ссылка на изображение печати организации
stampUrl string Нет Ссылка на изображение печати организации
stampSize integer · int32 Нет Размер в байтах изображения печати организации
stampWidth integer · int32 Нет Ширина изображения печати организации
stampHeight integer · int32 Нет Высота изображения печати организации
signaturePath string Нет Фото подписи директора организации
signatureUrl string Нет Фото подписи директора организации
signatureSize integer · int32 Нет Размер файла в байтах подписи директора организации
signatureWidth integer · int32 Нет Ширина изображения подписи директора
signatureHeight integer · int32 Нет Высота изображения подписи директора
ipPerson Person Нет Руководитель организации или ИП
Поля объекта Person
ПолеТипОбязательноОписание
personId integer · int64 Нет Поле personId.
firstName string Да Имя сотрудника
lastName string Да Фамилия сотрудника
surName string Нет Отчество сотрудника
clientId integer · int64 Нет Идентификатор клиента
position PersonPosition Да Должность сотрудника
versionId integer · int64 Нет Поле нужно передавать при изменении,для предотвращения одновременной перезаписи
createdUser string Нет Проставляется автоматически. Пользователь создавший сотрудника
createdDate string · date-time Нет Проставляется автоматически. Дата создания сотрудника
deleted boolean Нет Признак удаления сотрудника
userId integer · int32 Нет Связь сотрудника с пользователем
hasChanges boolean Нет Поле hasChanges.
fullName string Нет Полные ФИО
shortName string Нет Фамилия и инициалы
form stringOOO, IP, SELF_EMPLOYED Да Организационно правовая форма
ip boolean Нет Поле ip.
clientId integer · int64 Нет Идентификатор клиента
address Address Нет Адресс организации
Поля объекта Address
ПолеТипОбязательноОписание
id integer · int32 Нет Поле id.
postCode string Нет Поле postCode.
country Country Нет Поле country.
region Region Нет Поле region.
regionId integer · int32 Нет Поле regionId.
street string Нет Поле street.
house string Нет Поле house.
district string Нет Поле district.
city string Нет Поле city.
locality string Нет Поле locality.
building string Нет Поле building.
flat string Нет Поле flat.
short string Нет Поле short.
addressId Address Нет Поле addressId.
full string Нет Поле full.
phoneNumber string Нет Номер телефона
addressFull string Нет Полный адрес
additionalServiceForTariff DeliveryTariff Нет Поле additionalServiceForTariff.
Поля объекта DeliveryTariff
ПолеТипОбязательноОписание
deliverySum number · float Нет Стоимость доставки
periodMin integer · int32 Нет Минимальное время доставки (в рабочих днях)
periodMax integer · int32 Нет Максимальное время доставки (в рабочих днях)
calendarMin integer · int32 Нет Минимальное время доставки (в календарных днях)
calendarMax integer · int32 Нет Максимальное время доставки (в календарных днях)
tariffId integer · int32 Нет Уникальный идентификатор
shippingService stringCDEK, OWN_DELIVERY, POST, BOXBERRY, DPD, YANDEX, DOSTAVISTA, DELLIN, PEC, YANDEX_EXPRESS, FIVE_POST Нет Сервис доставки, которому принадлежит данный тариф
tariffCode integer · int32 Нет Код тарифа
externalTariffCode string Нет Внешний строковый идентификатор тарифа или предложения
tariffName string Нет Название тарифа
tariffDescription string Нет Описание тарифа
deliveryMode integer · int320, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 Нет Режим доставки
additionalServices AdditionalDeliveryServiceDto[] Нет Дополнительные услуги к тарифу
Структура элемента массива AdditionalDeliveryServiceDto
ПолеТипОбязательноОписание
code string Нет Поле code.
name string Нет Поле name.
description string Нет Поле description.
{
  "warehouseDeliveryId": 1001,
  "point": "string",
  "service": "CDEK",
  "warehouseId": 1001,
  "organizationId": 1001,
  "tariffPriority": "string"
}
Ошибки11

Прикладные ошибки обычно возвращаются как JSON с полями error, localMessage и params. Ориентируйтесь на error; локализованный текст может меняться. Как API возвращает прикладные ошибки ↑

401auth_required
Требуется авторизация

Заголовок Authorization отсутствует, пуст или содержит недействительный токен.

400error_access_denied
Недостаточно прав

Токен существует, но его роль не позволяет выполнить операцию.

500error_unknown
Непредвиденная ошибка

Внутренняя ошибка. Сохраните время запроса и обратитесь в поддержку, не повторяя мутацию вслепую.

400error_duplicate_warehouse_delivery_for_warehouse
Настройки службы доставки не могут дублироваться для склада

Персональная ошибка этого метода. Для программной логики используйте стабильный код error_duplicate_warehouse_delivery_for_warehouse; localMessage содержит приведённый выше перевод.

400error_empty_shipping_point
Не указан адрес отправки отправлений

Персональная ошибка этого метода. Для программной логики используйте стабильный код error_empty_shipping_point; localMessage содержит приведённый выше перевод.

400error_empty_shipping_service
Не указана служба доставки

Персональная ошибка этого метода. Для программной логики используйте стабильный код error_empty_shipping_service; localMessage содержит приведённый выше перевод.

400error_empty_tariff_priority
Не указан приоритет для тарифа

Персональная ошибка этого метода. Для программной логики используйте стабильный код error_empty_tariff_priority; localMessage содержит приведённый выше перевод.

400error_no_client
Клиент не найден или был удален. Напишите в поддержку

Персональная ошибка этого метода. Для программной логики используйте стабильный код error_no_client; localMessage содержит приведённый выше перевод.

400error_no_warehouse_delivery
Не указан пункт отправления для транспортной компании

Персональная ошибка этого метода. Для программной логики используйте стабильный код error_no_warehouse_delivery; localMessage содержит приведённый выше перевод.

400error_organization_not_found
Не найдена организация

Персональная ошибка этого метода. Для программной логики используйте стабильный код error_organization_not_found; localMessage содержит приведённый выше перевод.

400error_subscription_expired
У вас закончился срок действия тарифа. Оплатите тариф для продолжения использования сервиса.

Персональная ошибка этого метода. Для программной логики используйте стабильный код error_subscription_expired; localMessage содержит приведённый выше перевод.

POST

Удалить пункт доставки со склада

/api/delivery/removeWarehouseDelivery
Токен с правами записи

Удалить пункт доставки со склада.

Тело запроса

application/json
Поля объектаWarehouseDelivery
ПолеТипОбязательноОписание
warehouseDeliveryId integer · int64 Нет Поле warehouseDeliveryId.
point string Нет Поле point.
service stringCDEK, OWN_DELIVERY, POST, BOXBERRY, DPD, YANDEX, DOSTAVISTA, DELLIN, PEC, YANDEX_EXPRESS, FIVE_POST Нет Поле service.
warehouseId integer · int64 Нет Поле warehouseId.
organizationId integer · int64 Нет Поле organizationId.
tariffPriority string Нет Поле tariffPriority.
priorities object Нет Поле priorities.
priorityByMode boolean Нет Поле priorityByMode.
additionalServices string Нет Поле additionalServices.
sendZeroPrice boolean Нет Поле sendZeroPrice.
fakeName string Нет Поле fakeName.
hideOrganization boolean Нет Поле hideOrganization.
sellerOrganizationId integer · int64 Нет Поле sellerOrganizationId.
organization Organization Нет Поле organization.
Поля объекта Organization
ПолеТипОбязательноОписание
id integer · int64 Нет Идентификатор организации. Проставляется автоматически
name string Да Полное наименование организации
shortName string Нет Поле shortName.
taxType stringYSN, YSN_CONSUMPTION, AUSN, AUSN_CONSUMPTION, OSNO, SELF_EMPLOYED Нет Система налогооблажения
taxRate integer · int32 Нет Ставка налога, если она отличается от стандартной
taxNds integer · int32 Нет Ставка налога, если она отличается от стандартной
inputTaxNds integer · int32 Нет Ставка входящего НДС
outputTaxNds integer · int32 Нет Ставка исходящего НДС
enableNewTaxCalculation boolean Нет Включить расчет налогов по новым правилам
useNdsCostPrice boolean Нет Учитывать входящий НДС в себестоимости
inn string Да ИНН
kpp string Нет КПП. Проставляется только для ООО
bank string Нет Название банка
bik string Нет БИК счета организации
corrBill string Нет Номер корреспондентского счета
billNumber string Нет Номер счета организации
stampPath string Нет Ссылка на изображение печати организации
stampUrl string Нет Ссылка на изображение печати организации
stampSize integer · int32 Нет Размер в байтах изображения печати организации
stampWidth integer · int32 Нет Ширина изображения печати организации
stampHeight integer · int32 Нет Высота изображения печати организации
signaturePath string Нет Фото подписи директора организации
signatureUrl string Нет Фото подписи директора организации
signatureSize integer · int32 Нет Размер файла в байтах подписи директора организации
signatureWidth integer · int32 Нет Ширина изображения подписи директора
signatureHeight integer · int32 Нет Высота изображения подписи директора
ipPerson Person Нет Руководитель организации или ИП
Поля объекта Person
ПолеТипОбязательноОписание
personId integer · int64 Нет Поле personId.
firstName string Да Имя сотрудника
lastName string Да Фамилия сотрудника
surName string Нет Отчество сотрудника
clientId integer · int64 Нет Идентификатор клиента
position PersonPosition Да Должность сотрудника
versionId integer · int64 Нет Поле нужно передавать при изменении,для предотвращения одновременной перезаписи
createdUser string Нет Проставляется автоматически. Пользователь создавший сотрудника
createdDate string · date-time Нет Проставляется автоматически. Дата создания сотрудника
deleted boolean Нет Признак удаления сотрудника
userId integer · int32 Нет Связь сотрудника с пользователем
hasChanges boolean Нет Поле hasChanges.
fullName string Нет Полные ФИО
shortName string Нет Фамилия и инициалы
form stringOOO, IP, SELF_EMPLOYED Да Организационно правовая форма
ip boolean Нет Поле ip.
clientId integer · int64 Нет Идентификатор клиента
address Address Нет Адресс организации
Поля объекта Address
ПолеТипОбязательноОписание
id integer · int32 Нет Поле id.
postCode string Нет Поле postCode.
country Country Нет Поле country.
region Region Нет Поле region.
regionId integer · int32 Нет Поле regionId.
street string Нет Поле street.
house string Нет Поле house.
district string Нет Поле district.
city string Нет Поле city.
locality string Нет Поле locality.
building string Нет Поле building.
flat string Нет Поле flat.
short string Нет Поле short.
addressId Address Нет Поле addressId.
full string Нет Поле full.
phoneNumber string Нет Номер телефона
addressFull string Нет Полный адрес
additionalServiceForTariff DeliveryTariff Нет Поле additionalServiceForTariff.
Поля объекта DeliveryTariff
ПолеТипОбязательноОписание
deliverySum number · float Нет Стоимость доставки
periodMin integer · int32 Нет Минимальное время доставки (в рабочих днях)
periodMax integer · int32 Нет Максимальное время доставки (в рабочих днях)
calendarMin integer · int32 Нет Минимальное время доставки (в календарных днях)
calendarMax integer · int32 Нет Максимальное время доставки (в календарных днях)
tariffId integer · int32 Нет Уникальный идентификатор
shippingService stringCDEK, OWN_DELIVERY, POST, BOXBERRY, DPD, YANDEX, DOSTAVISTA, DELLIN, PEC, YANDEX_EXPRESS, FIVE_POST Нет Сервис доставки, которому принадлежит данный тариф
tariffCode integer · int32 Нет Код тарифа
externalTariffCode string Нет Внешний строковый идентификатор тарифа или предложения
tariffName string Нет Название тарифа
tariffDescription string Нет Описание тарифа
deliveryMode integer · int320, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 Нет Режим доставки
additionalServices AdditionalDeliveryServiceDto[] Нет Дополнительные услуги к тарифу
Структура элемента массива AdditionalDeliveryServiceDto
ПолеТипОбязательноОписание
code string Нет Поле code.
name string Нет Поле name.
description string Нет Поле description.
curl --request POST 'https://api.selsup.ru/api/delivery/removeWarehouseDelivery' \
  --header 'Authorization: YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "warehouseDeliveryId": 1001,
  "point": "string",
  "service": "CDEK",
  "warehouseId": 1001,
  "organizationId": 1001,
  "tariffPriority": "string"
}'

Успешный ответ

200

Тело ответа пустое.

Ошибки6

Прикладные ошибки обычно возвращаются как JSON с полями error, localMessage и params. Ориентируйтесь на error; локализованный текст может меняться. Как API возвращает прикладные ошибки ↑

401auth_required
Требуется авторизация

Заголовок Authorization отсутствует, пуст или содержит недействительный токен.

400error_access_denied
Недостаточно прав

Токен существует, но его роль не позволяет выполнить операцию.

500error_unknown
Непредвиденная ошибка

Внутренняя ошибка. Сохраните время запроса и обратитесь в поддержку, не повторяя мутацию вслепую.

400error_no_client
Клиент не найден или был удален. Напишите в поддержку

Персональная ошибка этого метода. Для программной логики используйте стабильный код error_no_client; localMessage содержит приведённый выше перевод.

400error_organization_not_found
Не найдена организация

Персональная ошибка этого метода. Для программной логики используйте стабильный код error_organization_not_found; localMessage содержит приведённый выше перевод.

400error_subscription_expired
У вас закончился срок действия тарифа. Оплатите тариф для продолжения использования сервиса.

Персональная ошибка этого метода. Для программной логики используйте стабильный код error_subscription_expired; localMessage содержит приведённый выше перевод.

POST

Создание заказа в сервисе доставки

/api/delivery/order/{orderId}
Токен с правами записи

Позволяет создать заказ в службе доставки из заказа SelSup. При этом в заказе должен быть проставлен пункт доставки

Параметры пути

ПолеТипОбязательноОписание
orderId integer · int64 Да Идентификатор заказа

Параметры запроса

ПолеТипОбязательноОписание
service stringCDEK, OWN_DELIVERY, POST, BOXBERRY, DPD, YANDEX, DOSTAVISTA, DELLIN, PEC, YANDEX_EXPRESS, FIVE_POST Нет Сервис доставки

Тело запроса

application/json
Поля объектаDeliveryTariff
ПолеТипОбязательноОписание
deliverySum number · float Нет Стоимость доставки
periodMin integer · int32 Нет Минимальное время доставки (в рабочих днях)
periodMax integer · int32 Нет Максимальное время доставки (в рабочих днях)
calendarMin integer · int32 Нет Минимальное время доставки (в календарных днях)
calendarMax integer · int32 Нет Максимальное время доставки (в календарных днях)
tariffId integer · int32 Нет Уникальный идентификатор
shippingService stringCDEK, OWN_DELIVERY, POST, BOXBERRY, DPD, YANDEX, DOSTAVISTA, DELLIN, PEC, YANDEX_EXPRESS, FIVE_POST Нет Сервис доставки, которому принадлежит данный тариф
tariffCode integer · int32 Нет Код тарифа
externalTariffCode string Нет Внешний строковый идентификатор тарифа или предложения
tariffName string Нет Название тарифа
tariffDescription string Нет Описание тарифа
deliveryMode integer · int320, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 Нет Режим доставки
additionalServices AdditionalDeliveryServiceDto[] Нет Дополнительные услуги к тарифу
Структура элемента массива AdditionalDeliveryServiceDto
ПолеТипОбязательноОписание
code string Нет Поле code.
name string Нет Поле name.
description string Нет Поле description.
curl --request POST 'https://api.selsup.ru/api/delivery/order/1001' \
  --header 'Authorization: YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "deliverySum": 1,
  "periodMin": 1,
  "periodMax": 1,
  "calendarMin": 1,
  "calendarMax": 1,
  "tariffId": 1001
}'

Успешный ответ

200

Тело ответа пустое.

Ошибки3

Прикладные ошибки обычно возвращаются как JSON с полями error, localMessage и params. Ориентируйтесь на error; локализованный текст может меняться. Как API возвращает прикладные ошибки ↑

401auth_required
Требуется авторизация

Заголовок Authorization отсутствует, пуст или содержит недействительный токен.

400error_access_denied
Недостаточно прав

Токен существует, но его роль не позволяет выполнить операцию.

500error_unknown
Непредвиденная ошибка

Внутренняя ошибка. Сохраните время запроса и обратитесь в поддержку, не повторяя мутацию вслепую.

POST

Список доступных тарифов для заказа

/api/delivery/getTariffs
Токен с правами записи

Список доступных тарифов для заказа.

Параметры запроса

ПолеТипОбязательноОписание
service stringCDEK, OWN_DELIVERY, POST, BOXBERRY, DPD, YANDEX, DOSTAVISTA, DELLIN, PEC, YANDEX_EXPRESS, FIVE_POST Да Сервис доставки
orderId integer · int64 Да Идентификатор заказа
curl --request POST 'https://api.selsup.ru/api/delivery/getTariffs?service=CDEK&orderId=1001' \
  --header 'Authorization: YOUR_API_TOKEN'

Успешный ответ

200
Структура элемента массива DeliveryTariff[]
ПолеТипОбязательноОписание
deliverySum number · float Нет Стоимость доставки
periodMin integer · int32 Нет Минимальное время доставки (в рабочих днях)
periodMax integer · int32 Нет Максимальное время доставки (в рабочих днях)
calendarMin integer · int32 Нет Минимальное время доставки (в календарных днях)
calendarMax integer · int32 Нет Максимальное время доставки (в календарных днях)
tariffId integer · int32 Нет Уникальный идентификатор
shippingService stringCDEK, OWN_DELIVERY, POST, BOXBERRY, DPD, YANDEX, DOSTAVISTA, DELLIN, PEC, YANDEX_EXPRESS, FIVE_POST Нет Сервис доставки, которому принадлежит данный тариф
tariffCode integer · int32 Нет Код тарифа
externalTariffCode string Нет Внешний строковый идентификатор тарифа или предложения
tariffName string Нет Название тарифа
tariffDescription string Нет Описание тарифа
deliveryMode integer · int320, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 Нет Режим доставки
additionalServices AdditionalDeliveryServiceDto[] Нет Дополнительные услуги к тарифу
Структура элемента массива AdditionalDeliveryServiceDto
ПолеТипОбязательноОписание
code string Нет Поле code.
name string Нет Поле name.
description string Нет Поле description.
[
  "string"
]
Ошибки3

Прикладные ошибки обычно возвращаются как JSON с полями error, localMessage и params. Ориентируйтесь на error; локализованный текст может меняться. Как API возвращает прикладные ошибки ↑

401auth_required
Требуется авторизация

Заголовок Authorization отсутствует, пуст или содержит недействительный токен.

400error_access_denied
Недостаточно прав

Токен существует, но его роль не позволяет выполнить операцию.

500error_unknown
Непредвиденная ошибка

Внутренняя ошибка. Сохраните время запроса и обратитесь в поддержку, не повторяя мутацию вслепую.

POST

Скачивает PDF файл со всеми накладными службы доставки

/api/delivery/downloadDeliveryLabels
Токен с правами записи

Скачивает PDF файл со всеми накладными службы доставки.

Параметры запроса

ПолеТипОбязательноОписание
columns FileExportColumn[] Нет Настройки столбцов для экспорта отчета по заказам
Структура элемента массива FileExportColumn
ПолеТипОбязательноОписание
id integer · int64 Нет ID записи
fileExportId integer · int64 Нет ID конфигурации экспорта
columnName string Нет Название столбца
columnOrder integer · int32 Нет Порядок столбца в файле
isEnabled boolean Нет Включен ли столбец для экспорта
actual boolean Нет Отображать только актуальные заказы - не закрытые?
type stringFBM, FBS, INCOME, RETAIL, WHOLESALE, FBO, MOVEMENT, WRITE_OFF, PRODUCTION Нет Тип заказа
serviceWarehouseId string Нет Внешний номер склада
externalOrderId string Нет Внешний номер заказа
invoiceNumber integer · int64 Нет ID Номера счета
article string Нет Фильтр по артикулу модели товара в заказе
containsArticle string Нет Поле containsArticle.
product string Нет Фильтр по названию товара в заказе
barcode string Нет Фильтр по точному штрихкоду товара в заказе
organizations integer[] Нет Фильтр по ID организации. Можно передавать несколько значений organizations=123&organizations=345
query string Нет Поисковый запрос для фильтрации заказов по номеру, названию или QR/штрихкоду стикера
userId integer · int32 Нет ID пользователя который брал на сборку заказ
service stringNONE, WILDBERRIES, OZON, YANDEX_MARKET, FAMILIYA, NATIONAL_CATALOG, ALIEXPRESS, OTHER, MOY_SKLAD, SBER_MEGA_MARKET, CISLINK, ONE_C, AVITO, LEROY_MERLIN, DETMIR, KAZAN_EXPRESS, EVOTOR, WEBASYST, AMAZON, EBAY, SIMALAND, INSALES, LAMODA, OZON_PERFORMANCE, WALMART, GOOGLE, YANDEX_DISC, EMAIL, WOOCOMMERCE, MAGNIT, OPENCART, M_VIDEO, TAKEALOT, UZUM, SHOPIFY, MAKRO, YANDEX_KIT, BOB_SHOP, KASPI, DIADOC Нет Сервис
services string[] Нет Список маркетплейсов для которых отдать данные
status stringCREATED, REVOKING, REVOKED, ORDER_CREATED, CARDS_CREATED, BOX_BARCODES, IMAGES_UPLOADED, INVOICE_UPLOADED, READY_TO_SUPPLY, SUPPLIED, FINISHED, COLLECTED, SEND, DELIVERY, REFUND, COLLECTING, PACKING, PAYMENT_REQUIRED, CANCELED, CONTROVERSIAL, OVERDUE, READY_FOR_PICKUP, WAITING_SUPPLY, PICK_UP_REFUND, REFUND_RECEIVED, DELETED, RESTORE, PRODUCTION_CONFIRMED Нет Статус заказа
statuses string[] Нет Фильтр по статусам заказа. Можно передавать несколько значений statuses=CREATED&statuses=PACKING
withoutSupply boolean Нет Фильтр по заказам не прикрепленным к поставке?
orderProductId integer · int64 Нет Фильтр по ID позиции в заказе
productId integer · int64 Нет Фильтр по ID товара из заказа
brandId integer · int32 Нет Фильтр по ID бренда товара из заказа
supplierId integer · int64 Нет Фильтр по поставщику
hasCollectTask boolean Нет Фильтр по наличию у заказа сборочного задания?
organizationId integer · int64 Нет Фильтр по ID организации заказа
clientOrganizationIds integer[] Нет Идентификаторы организаций клиента
updateInService boolean Нет Заказы, которые стоят в очереди на изменение статуса на маркетплейсе?
hasServiceError boolean Нет Заказы с ошибкой обновления статуса на маркетплейсе?
noLabel boolean Нет Фильтрует заказы без этикетки?
isLegal boolean Нет Фильтрует заказы для бизнеса
noMsOrder boolean Нет Фильтрует по заказам не созданным в Моем складе?
noMsDemand boolean Нет Фильтрует по заказам с несозданными отгрузками в Моем складе?
ids integer[] Нет ID заказов. Можно передавать несколько значений ids=123&ids=345
supplyId integer · int64 Нет ID поставки, в которой отгружается заказ
notCollected boolean Нет Заказы, которые не собирались через SelSup?
dbs boolean Нет DBS заказы?
express boolean Нет Express заказы?
fbs boolean Нет FBS заказы?
noWarehouse boolean Нет Заказы без склада?
closeDate string Нет Фильтр по дате сборки заказа - конкретный день
modifiedDate string · date-time Нет Фильтр по дате изменения заказа - статуса или любой информации о заказе начиная с этой даты
modifiedDateTo string · date-time Нет Фильтр по дате изменения заказа - статуса или любой информации о заказе до этой даты
incomeId integer · int64 Нет ID закупки из которого создан заказ
bindingOrderId integer · int64 Нет ID заказа, которому делаем возврат
closeDateFrom string · date-time Нет Фильтр по дате сборки заказа от - ISO
closeDateTo string · date-time Нет Фильтр по дате сборки заказа до - ISO
orderDate string Нет Фильтр по дате заказа
deliveryDate string Нет Фильтр по дате доставки заказа
deliveryDateFrom string Нет Фильтр по дате доставки заказа от
deliveryDateTo string Нет Фильтр по дате доставки заказа до
createdDateFrom string Нет Фильтр по дате создания заказа от
createdDateTo string Нет Фильтр по дате создания заказа до
forMoySklad boolean Нет Для создания в МойСклад?
withMoySkladOrder boolean Нет Только заказы, у которых уже есть заказ в МойСклад (moy_sklad_id задан)
warehouseId integer · int64 Нет Фильтр по ID склада, с которого отгружается заказ
warehouseIds integer[] Нет Фильтр по ID складам, с которого отгружается заказ. Можно передавать несколько значений warehouseIds=123&warehouseIds=345
dateFrom string · date-time Нет Фильтр по дате заказа - от
dateTo string · date-time Нет Фильтр по дате заказа - до
timeZone integer · int32 Нет ID часового пояса клиента по UTC в часах, например 3
markingStatus stringUNKNOWN, CARDS_SEND, CARDS_CREATED, SUZ_ORDERS_CREATED, MARKS_RECEIVED, CARDS_SIGNED, DOCUMENT_CREATED, SUCCESS, NO_NEED_MARKING Нет Фильтр по статусу в честном знаке
deleted boolean Нет Показать удаленные заказы?
collectLabel boolean Нет Только для печати в PDF. Признак необходимости распечатать сборочную этикетку для "умной ленты"?
sortOrdersByDate boolean Нет Только для печати в PDF. Признак необходимости распечатать сборочную этикетку для "умной ленты"?
sortBySku boolean Нет Только для печати в PDF. Признак необходимости использовать в сортировке данные о товарах объединенных по SKU?
notGroupByOrganization boolean Нет Только для печати в PDF. Признак того, что все организации сортируются одним списком?
notGroupByService boolean Нет Только для печати в PDF. Признак того, что все маркетплейсы сортируются одним списком?
productLabel boolean Нет Только для печати в PDF. Признак необходимости распечатать этикетку товара в ленте?
productCodeLabel boolean Нет Только для печати в PDF. Признак необходимости распечатать этикетку кода маркировки в ленте?
servicesForLabel string[] Нет Сервисы для которых нужна печать в PDF
infoLabel boolean Нет Только для печати в PDF. Признак необходимости распечатать информационную этикетку для ленты заказов?
grouped boolean Нет Отдает сгруппированные позиции из заказов. Только для выгрузки в Excel?
replaceSetByComponent boolean Нет Заменяет в заказах комплекты на компоненты?
replaceSetsByComponentsIncome boolean Нет Заменяет в заказах комплекты на компоненты в файле закупки?
collectDeliveryLabel boolean Нет Только для печати в PDF. Признак необходимости распечатать накладную службы доставки для "умной ленты"?
shippingServicesForLabel string[] Нет Сервисы доставки для которых нужна печать накладной в PDF
orderId integer · int64 Нет ID заказа
hasVideoFixation boolean Нет Идентификатор была ли видео фиксация?
withProducts boolean Нет Признак, что заказы необходимо отдать c товарами?
passageIds integer[] Нет Фильтр по ID проходов. Можно передавать несколько значений passageIds=123&passageIds=345
withContractor boolean Нет Включить информацию о поставщиках в выгрузку?
boxId integer · int64 Нет Идентификатор короба
hasMarkedProducts boolean Нет Фильтр по заказам, в которых есть товары, подлежащие маркировке
withAnalytics boolean Нет Загружать данные аналитики (commission, logistics, totalSellingExpenses, grossProfit) из profit_report? Без флага (по умолчанию false) эти поля не возвращаются в ответе. Замедляет запрос
limit integer · int32 Нет Ограничение на количество записей. Максимальное значение - 500
page integer · int32 Нет Номер страницы начиная с 1
count boolean Нет Возвратить в ответе общее количество записей
sortBy stringID, CREATEDDATE, ORDERCREATED, CREATED, CREATEDUSER, STATUS, SERVICE, TYPE, BOXTYPE, NAME, ORGANIZATIONID, WAREHOUSE, INVOICENUMBER, EXTERNALORDERID, QUEUE, SUPPLYID, CLOSEDATE, STARTCOLLECTDATE, CLOSEUSERID, USERID, PRICE, PRODUCT, COLLECTORDERTASKID, DELIVERYDATE, MARKINGSTATUS, QUANTITY, DATE, SERVICEWAREHOUSEID Нет Поле для сортировки
ascending boolean Нет Порядок сортировки - по возрастанию?. Работает только при получении списка.
curl --request POST 'https://api.selsup.ru/api/delivery/downloadDeliveryLabels?limit=50&page=1' \
  --header 'Authorization: YOUR_API_TOKEN'

Успешный ответ

200
Поля объекта TmsTask
ПолеТипОбязательноОписание
id integer · int64 Нет Идентификатор задачи
status stringCREATED, RUNNING, FINISHED, ERROR, RESTARTING, INTERRUPTING, INTERRUPTED, STOPPED, EXCEPTION Нет Текущий статус задачи
type stringWILDBERRIES_CREATE_CARD, NATIONAL_CATALOG_CREATE_CARD, OZON_CREATE_CARD, OZON_CARDS_IMPORT, IMPORT_FBS_ORDERS, UPLOAD_PHOTOGRAPHY, WILDBERRIES_UPDATE_PRICE, WILDBERRIES_CARD_IMPORT, WILDBERRIES_CARD_UPDATE, SELSUP_STOCKS, REFRESH_PHOTOGRAPHY, SUPPLYING_QUANTITY_TASK, EXPORT_PRICE, OZON_UPDATE_PRICE, WILDBERRIES_FILE_TASK, YANDEX_MARKET_CARD_CREATE, OZON_CARD_UPDATE_TASK, OZON_IMPORT_STAT_TASK, WILDBERRIES_PROFIT_STAT_TASK, ALIEXPRESS_CREATE_CARD_TASK, ALIEXPRESS_UPDATE_CARD_TASK, PRICES_IMPORT_TASK, WILDBERRIES_PRICES_TASK, YANDEX_MARKET_CARD_IMPORT, STOCKS_UPDATE, WILDBERRIES_STOCKS_IMPORT_TASK, WILDBERRIES_ORDERS_AND_SALES_TASK, WILDBERRIES_INCOMES_IMPORT_TASK, OZON_STOCKS_IMPORT_TASK, TURNOVER_DOCUMENTS_TASK, INTRODUCE_WMS_ITEMS_TASK, PRODUCTS_FILE_TASK, MODELS_FILE_TASK, UPDATE_PRODUCT_CODES_TASK, INTRODUCE_CODES_TASK, PRODUCTS_IMPORT_TASK, PRICES_FILE_TASK, YANDEX_MARKET_UPDATE_PRICE_TASK, IMPORT_STOCKS_TASK, MOY_SKLAD_EXPORT_ORDERS, MERGE_PRODUCTS_TASK, PRODUCTS_WILDBERRIES_EXCEL_IMPORT_TASK, MOY_SKLAD_CREATE_CARD, IMPORT_FBO_STOCKS_FROM_FILE, CREATE_WMS_ITEMS, MOY_SKLAD_CARDS_IMPORT, PROMOTION_FILE, UNUSED_1, UNUSED, PRODUCT_ANALYTICS_FILE_TASK, PROMOTION_RESET_FILE, MOY_SKLAD_IMPORT_ORDERS, FINANCE_REPORT_FILE_TASK, YML_FILE_EXPORT, PRODUCT_BALANCE_REPORT_FILE_TASK, CURRENT_PRODUCT_BALANCE_FILE_TASK, IMPORT_TRANSACTIONS, MATCH_UNREGISTERED_PROFIT_REPORT_TASK, UPDATE_AVERAGE_SERVICE_EXPENSES_TASK, YANDEX_MARKET_ORDER_IMPORT_STAT_TASK, ABC_REPORT_FILE_TASK, MODEL_CONTRACTORS_IMPORT, MODEL_CONTRACTORS_EXPORT, BANK_TRANSACTION_IMPORT_FILE_TASK, YML_IMPORT_TASK, SALES_DYNAMIC_REPORT_FILE_TASK, UPDATE_FBS_ORDERS, EXPORT_TRANSACTION_IN_EXCEL_FILE_TASK, IMPORT_TRANSACTION_FROM_EXCEL_FILE_TASK, EXPORT_PROFIT_REPORT_FILE_TASK, IMPORT_PROFIT_REPORT_FROM_EXCEL_FILE_TASK, IMPORT_REALIZATION_REPORT_TASK, STOCK_RECONCILIATION, ORDER_REPORT_FILE_TASK, GET_WB_FBO_ORDER_FROM_PROFIT_REPORT_TASK, TO_QUANTITY_STORAGE_METHOD, APPLY_RECONCILIATION, OZON_IMPORT_FBO_ORDERS_TASK, UPDATE_PURCHASE_PRICE_IN_PROFIT_REPORT_TASK, FBS_LABELS, MERGE_PRODUCT_STOCKS, CREATE_ORDER_FROM_FILE, ALIEXPRESS_CARD_IMPORT, PRICE_LIST_IMPORT, WB_STOCK_REPORT_FILE, CONTRACTORS_REPORT_FILE, PRODUCTS_SBER_MEGA_MARKET_EXCEL_IMPORT_TASK, EXPORT_PROBLEMATIC_PRODUCT_REPORT, PLAN_SUPPLY_REPORT_TASK, PLAN_FACT_SALES_REPORT_FILE, IMPORT_PLAN_SALES_FROM_EXCEL_FILE_TASK, EXPORT_PLAN_SALES_EXCEL_FILE_TASK, ORDERS_TO_BUY_FILE_TASK, MERGE_PRICE_ON_OTHER_MP_TASK, MATCH_PRODUCT_LAST_OPERATION_DATE_TASK, PROBLEMATIC_PRODUCT_PRICE_FILE_TASK, CATEGORIES_IMPORT_EXCEL_TASK, AVITO_CARD_IMPORT, UPDATE_OLD_WB_ORDER_STATUSES_TASK, PRESTA_SHOP_IMPORT_TASK, PRODUCTS_AVITO_EXCEL_IMPORT_TASK, FBO_STOCK_RECONCILIATION_TASK, APPLY_FBO_RECONCILIATION_TASK, EXPORT_REPRICE_PRODUCT_CONFIG_TASK, IMPORT_REPRICE_PRODUCT_CONFIG_TASK, OZON_CASH_FLOW_STATEMENT_IMPORT_TASK, IMPORT_PROMOTION_STRATEGY_FILE_TASK, UPDATE_ORDER_DELIVERY_INFO_TASK, BILLING_OPERATION_TASK, SET_PURCHASE_PERCENT_TASK, REMOVE_PRODUCT_IMAGES_TASK, STRUCTURE_TURNOVER_TASK, OZON_NEW_UPDATE_PRICE, REPLACE_PRODUCT_IMAGE_TASK, UPDATE_OZON_PROMOTION_DATA_TASK, WILDBERRIES_IMPORT_CAMPAIGN_TASK, WILDBERRIES_STORAGE_REPORT_TASK, WEBASYST_LINK_ARTICLE_TASK, DELIVERY_SERVICE_LABELS, HAND_ON_PULSE_FILE_TASK, ITEMS_INCOME_EXCEL_TASK, UPDATE_SETS_EXCEL_TASK, DELETE_PROFIT_REPORTS_BY_FILE_HISTORY_IDS_TASK, EXPORT_PRODUCT_SETS_TASK, AMAZON_CARD_IMPORT, IMPORT_ACCEPTED_PRODUCTS_TASK, ADD_ORDER_PRODUCT_FROM_FILE_TASK, EXPORT_ITEM_HISTORY_FILE_TASK, WILDBERRIES_IMPORT_CAMPAIGN_BY_EXCEL_TASK, REMOVE_CLIENT_ORGANIZATION, EBAY_CARD_IMPORT_TASK, PRODUCTS_IMPORT_FROM_ORGANIZATION_TASK, IMPORT_FBO_ORDERS, LAMODA_CARD_IMPORT, UPDATE_WB_PROMOTION_DATA_TASK, IMPORT_RETURNS_REPORT_TASK, UPDATE_PROMOTION_DATA_TASK, RESTORE_CLIENT_ORGANIZATION, LEROY_MERLIN_CARD_IMPORT, YANDEX_MARKET_STOCKS_IMPORT_TASK, WILDBERRIES_IMPORT_NM_REPORT_TASK, ORDER_ANALYTICS_FILE_TASK, CLIENT_DATABASE_MOVE_TASK, FAST_CARD_IMPORT, EXPORT_PRODUCT_CODE, INSALES_CARD_IMPORT_TASK, REMOVE_PRODUCT_VIDEOS_TASK, UPDATE_CARDS_TASK, FIND_UNPROFITABLE_PRODUCTS_TASK, FIND_UNPURCHASED_PRODUCTS_TASK, WALMART_CARD_IMPORT, PRODUCT_GROUPS_TASK, CONTRACTOR_ARTICLE_EXPORT_TASK, CONTRACTOR_ARTICLE_IMPORT_TASK, CURRENCY_CONVERSION_TASK, UPDATE_SUPPLY_PLAN_REPORT_TASK, EXPORT_SUPPLY_PLAN_REPORT_FILE_TASK, CHECK_STOCK_ORDER, PHOTOGRAPHY_EXCEL, PREPARE_FINDIR_DATA_TASK, CARD_SPLITTING_TASK, EXPORT_IMAGE_UPDATES_TEMPLATE_TASK, IMPORT_IMAGE_UPDATES_TASK, PREPARE_PRODUCT_HAND_ON_PULSE_TASK, UPDATE_OZON_AVERAGE_DELIVERY_TIME, UPDATE_COMMISSIONS_TASK, WOOCOMMERCE_CARD_IMPORT, UPDATE_FBS_STOCKS_HISTORY, RETURNS_FILE_TASK, FAST_PRODUCTS_IMPORT_TASK, ANALYZE_PRODUCT_CARDS_TASK, DETMIR_CARD_IMPORT, MATCH_OZON_REALIZATION_REPORT_TASK, MAGNIT_IMPORT_PRODUCTS_TASK, UPDATE_PURCHASE_PRICE_FROM_STOCKS_IN_PROFIT_REPORT_TASK, MOY_SKLAD_FBO_MP_DATES_FIX, PRICE_HISTORY_FILE_TASK, FBM_ORDERS_IMPORT_TASK, UZUM_IMPORT_PRODUCTS_TASK, OPENCART_CARD_IMPORT, CARDS_IMPORT, OZON_CROSSDOCK_TRANSIT_ROUTES_TASK, UNUSED_2, OZON_IMPORT_SALES_FUNNEL_REPORT_TASK, WRITE_OFF_PRODUCTS_FILE_TASK, CLIENT_DATABASE_CREATE_TASK, UPDATE_FBS_LABELS_TASK, REBUILD_PROFIT_REPORT_HOURLY_AGGREGATE_TASK, OZON_IMPORT_CAMPAIGN_TASK, EXPORT_SUPPLY_PLAN_FILE_TASK, IMPORT_SUPPLY_PLAN_FILE_TASK, CREATE_SERVICE_CARDS, WAREHOUSE_ECONOMICS_FILE_TASK, UPDATE_WILDBERRIES_ACQUIRING_RATE_TASK, PRODUCT_SALES_FORECAST_TASK, UPDATE_PRODUCT_CODES_STATUSES_TASK, MARKETPLACE_UPDATE_PRICE_TASK, UZUM_IMPORT_STAT_TASK, CAMPAIGN_STATS_FILE_TASK, OZON_FBO_WORKFLOW_TASK, EXPORT_CERTIFICATE_TEMPLATE_TASK, IMPORT_CERTIFICATES_TASK, REBUILD_LOCAL_ORDER_PROFIT_REPORT_TASK, SHOPIFY_CARD_IMPORT Нет Тип задачи
name string Нет Данные задачи в json - могут быть пустыми
clientId integer · int64 Нет Поле clientId.
entityId integer · int64 Нет Сущность, к которой относится задача
progress integer · int32 Нет Прогресс выполнения задачи в процентах
processedQuantity integer · int32 Нет Количество обработанных записей задачи
organizationId integer · int64 Нет Организация задачи, может быть 0, если не зависит от организации
priority integer · int32 Нет Приоритет задачи - чем выше тем быстрее задача запустится
properties string Нет Параметры задачи
message string Нет Сообщение с результатом выполнения задачи
messageParams string Нет Параметры сообщения с результатом выполнения задачи
createdDate string · date-time Нет Дата добавления задачи в очередь
startDate string · date-time Нет Дата запуска задачи
finishDate string · date-time Нет Дата завершения задачи
url string Нет Ссылка на скачивание файла с результатом задачи
inputFileUrl string Нет Ссылка на загруженный файл
retryNumber integer · int32 Нет Счётчик перезапуска задачи.
userId integer · int32 Нет Пользователь запустивший задачу
retryDate string · date-time Нет Запланированная дата перезапуска
debug boolean Нет Запуск задачи в режиме отладки с большим логированием
forcedStart boolean Нет Ручной запуск задачи
service stringNONE, WILDBERRIES, OZON, YANDEX_MARKET, FAMILIYA, NATIONAL_CATALOG, ALIEXPRESS, OTHER, MOY_SKLAD, SBER_MEGA_MARKET, CISLINK, ONE_C, AVITO, LEROY_MERLIN, DETMIR, KAZAN_EXPRESS, EVOTOR, WEBASYST, AMAZON, EBAY, SIMALAND, INSALES, LAMODA, OZON_PERFORMANCE, WALMART, GOOGLE, YANDEX_DISC, EMAIL, WOOCOMMERCE, MAGNIT, OPENCART, M_VIDEO, TAKEALOT, UZUM, SHOPIFY, MAKRO, YANDEX_KIT, BOB_SHOP, KASPI, DIADOC Нет Сервис в рамках которого выполняется задача
lang string Нет Язык на котором сейчас запущена таска
{
  "id": 1001,
  "status": "CREATED",
  "type": "WILDBERRIES_CREATE_CARD",
  "name": "Example",
  "clientId": 1001,
  "entityId": 1001
}
Ошибки3

Прикладные ошибки обычно возвращаются как JSON с полями error, localMessage и params. Ориентируйтесь на error; локализованный текст может меняться. Как API возвращает прикладные ошибки ↑

401auth_required
Требуется авторизация

Заголовок Authorization отсутствует, пуст или содержит недействительный токен.

400error_access_denied
Недостаточно прав

Токен существует, но его роль не позволяет выполнить операцию.

500error_unknown
Непредвиденная ошибка

Внутренняя ошибка. Сохраните время запроса и обратитесь в поддержку, не повторяя мутацию вслепую.

POST

Отмена заказа в сервисе доставки

/api/delivery/cancelDeliveryOrder
Токен с правами записи

Отмена заказа в сервисе доставки.

Параметры запроса

ПолеТипОбязательноОписание
orderId integer · int64 Да Идентификатор заказа
curl --request POST 'https://api.selsup.ru/api/delivery/cancelDeliveryOrder?orderId=1001' \
  --header 'Authorization: YOUR_API_TOKEN'

Успешный ответ

200

Тело ответа пустое.

Ошибки3

Прикладные ошибки обычно возвращаются как JSON с полями error, localMessage и params. Ориентируйтесь на error; локализованный текст может меняться. Как API возвращает прикладные ошибки ↑

401auth_required
Требуется авторизация

Заголовок Authorization отсутствует, пуст или содержит недействительный токен.

400error_access_denied
Недостаточно прав

Токен существует, но его роль не позволяет выполнить операцию.

500error_unknown
Непредвиденная ошибка

Внутренняя ошибка. Сохраните время запроса и обратитесь в поддержку, не повторяя мутацию вслепую.

POST

Расчет стоимости конкретного тарифа для указанных данных заказа с дополнительными услугами

/api/delivery/calculateTariff
Токен с правами записи

Расчет стоимости конкретного тарифа для указанных данных заказа с дополнительными услугами.

Параметры запроса

ПолеТипОбязательноОписание
tariffCode integer · int32 Да Код тарифа для доставки
service stringCDEK, OWN_DELIVERY, POST, BOXBERRY, DPD, YANDEX, DOSTAVISTA, DELLIN, PEC, YANDEX_EXPRESS, FIVE_POST Да Сервис доставки
orderId integer · int64 Да Идентификатор заказа
curl --request POST 'https://api.selsup.ru/api/delivery/calculateTariff?tariffCode=1&service=CDEK&orderId=1001' \
  --header 'Authorization: YOUR_API_TOKEN'

Успешный ответ

200
Поля объекта CalculatedDeliveryTariff
ПолеТипОбязательноОписание
deliverySum number · float Нет Стоимость доставки
periodMin integer · int32 Нет Минимальное время доставки (в рабочих днях)
periodMax integer · int32 Нет Максимальное время доставки (в рабочих днях)
calendarMin integer · int32 Нет Минимальное время доставки (в календарных днях)
calendarMax integer · int32 Нет Максимальное время доставки (в календарных днях)
services object Нет Поле services.
locationToCode string Нет Поле locationToCode.
locationFromCode string Нет Поле locationFromCode.
tariffCode integer · int32 Нет Поле tariffCode.
deliveryModeToOrderCreate integer · int320, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 Нет Поле deliveryModeToOrderCreate.
deliveryModeList integer[] Нет Поле deliveryModeList.
{
  "deliverySum": 1,
  "periodMin": 1,
  "periodMax": 1,
  "calendarMin": 1,
  "calendarMax": 1,
  "services": "string"
}
Ошибки3

Прикладные ошибки обычно возвращаются как JSON с полями error, localMessage и params. Ориентируйтесь на error; локализованный текст может меняться. Как API возвращает прикладные ошибки ↑

401auth_required
Требуется авторизация

Заголовок Authorization отсутствует, пуст или содержит недействительный токен.

400error_access_denied
Недостаточно прав

Токен существует, но его роль не позволяет выполнить операцию.

500error_unknown
Непредвиденная ошибка

Внутренняя ошибка. Сохраните время запроса и обратитесь в поддержку, не повторяя мутацию вслепую.

POST

Добавить интеграцию с сервисом доставки

/api/delivery/addDeliveryServiceIntegration
Токен с правами записи

Позволяет добавить новую интеграцию с сервисом доставки

Параметры запроса

ПолеТипОбязательноОписание
service stringCDEK, OWN_DELIVERY, POST, BOXBERRY, DPD, YANDEX, DOSTAVISTA, DELLIN, PEC, YANDEX_EXPRESS, FIVE_POST Да Сервис доставки
serviceClientId string Да Клиентский идентификатор
serviceSecret string Нет Пароль/секрет
token string Нет Токен авторизации
organizationId integer · int64 Да Организация
curl --request POST 'https://api.selsup.ru/api/delivery/addDeliveryServiceIntegration?service=CDEK&serviceClientId=string&organizationId=1001' \
  --header 'Authorization: YOUR_API_TOKEN'

Успешный ответ

200

Тело ответа пустое.

Ошибки3

Прикладные ошибки обычно возвращаются как JSON с полями error, localMessage и params. Ориентируйтесь на error; локализованный текст может меняться. Как API возвращает прикладные ошибки ↑

401auth_required
Требуется авторизация

Заголовок Authorization отсутствует, пуст или содержит недействительный токен.

400error_access_denied
Недостаточно прав

Токен существует, но его роль не позволяет выполнить операцию.

500error_unknown
Непредвиденная ошибка

Внутренняя ошибка. Сохраните время запроса и обратитесь в поддержку, не повторяя мутацию вслепую.

GET

Получить интеграцию с сервисом доставки

/api/delivery/integration/{organizationId}/{service}
Токен с правами чтения

Получить интеграцию с сервисом доставки.

Параметры пути

ПолеТипОбязательноОписание
service stringCDEK, OWN_DELIVERY, POST, BOXBERRY, DPD, YANDEX, DOSTAVISTA, DELLIN, PEC, YANDEX_EXPRESS, FIVE_POST Да Сервис доставки
organizationId integer · int64 Да Организация
curl --request GET 'https://api.selsup.ru/api/delivery/integration/1001/CDEK' \
  --header 'Authorization: YOUR_API_TOKEN'

Успешный ответ

200
Поля объекта DeliveryServiceData
ПолеТипОбязательноОписание
id integer · int64 Нет Поле id.
tokenExpiredDate string · date-time Нет Поле tokenExpiredDate.
service stringCDEK, OWN_DELIVERY, POST, BOXBERRY, DPD, YANDEX, DOSTAVISTA, DELLIN, PEC, YANDEX_EXPRESS, FIVE_POST Нет Поле service.
serviceClientId string Нет Поле serviceClientId.
serviceSecret DeliveryServiceData Нет Поле serviceSecret.
clientId integer · int64 Нет Поле clientId.
organizationId integer · int64 Нет Поле organizationId.
updateToken boolean Нет Поле updateToken.
hasToken boolean Нет Поле hasToken.
hasSecret boolean Нет Поле hasSecret.
{
  "id": 1001,
  "tokenExpiredDate": "2026-01-15T12:00:00Z",
  "service": "CDEK",
  "serviceClientId": "string",
  "serviceSecret": "string",
  "clientId": 1001
}
Ошибки3

Прикладные ошибки обычно возвращаются как JSON с полями error, localMessage и params. Ориентируйтесь на error; локализованный текст может меняться. Как API возвращает прикладные ошибки ↑

401auth_required
Требуется авторизация

Заголовок Authorization отсутствует, пуст или содержит недействительный токен.

400error_access_denied
Недостаточно прав

Токен существует, но его роль не позволяет выполнить операцию.

500error_unknown
Непредвиденная ошибка

Внутренняя ошибка. Сохраните время запроса и обратитесь в поддержку, не повторяя мутацию вслепую.

GET

Выбрать пункты доставки со складов

/api/delivery/getWarehouseDelivery
Токен с правами чтения

Выбрать пункты доставки со складов.

Параметры запроса

ПолеТипОбязательноОписание
organizationId integer · int64 Да Поле organizationId.
service stringCDEK, OWN_DELIVERY, POST, BOXBERRY, DPD, YANDEX, DOSTAVISTA, DELLIN, PEC, YANDEX_EXPRESS, FIVE_POST Да Поле service.
curl --request GET 'https://api.selsup.ru/api/delivery/getWarehouseDelivery?organizationId=1001&service=CDEK' \
  --header 'Authorization: YOUR_API_TOKEN'

Успешный ответ

200
Структура элемента массива WarehouseDelivery[]
ПолеТипОбязательноОписание
warehouseDeliveryId integer · int64 Нет Поле warehouseDeliveryId.
point string Нет Поле point.
service stringCDEK, OWN_DELIVERY, POST, BOXBERRY, DPD, YANDEX, DOSTAVISTA, DELLIN, PEC, YANDEX_EXPRESS, FIVE_POST Нет Поле service.
warehouseId integer · int64 Нет Поле warehouseId.
organizationId integer · int64 Нет Поле organizationId.
tariffPriority string Нет Поле tariffPriority.
priorities object Нет Поле priorities.
priorityByMode boolean Нет Поле priorityByMode.
additionalServices string Нет Поле additionalServices.
sendZeroPrice boolean Нет Поле sendZeroPrice.
fakeName string Нет Поле fakeName.
hideOrganization boolean Нет Поле hideOrganization.
sellerOrganizationId integer · int64 Нет Поле sellerOrganizationId.
organization Organization Нет Поле organization.
Поля объекта Organization
ПолеТипОбязательноОписание
id integer · int64 Нет Идентификатор организации. Проставляется автоматически
name string Да Полное наименование организации
shortName string Нет Поле shortName.
taxType stringYSN, YSN_CONSUMPTION, AUSN, AUSN_CONSUMPTION, OSNO, SELF_EMPLOYED Нет Система налогооблажения
taxRate integer · int32 Нет Ставка налога, если она отличается от стандартной
taxNds integer · int32 Нет Ставка налога, если она отличается от стандартной
inputTaxNds integer · int32 Нет Ставка входящего НДС
outputTaxNds integer · int32 Нет Ставка исходящего НДС
enableNewTaxCalculation boolean Нет Включить расчет налогов по новым правилам
useNdsCostPrice boolean Нет Учитывать входящий НДС в себестоимости
inn string Да ИНН
kpp string Нет КПП. Проставляется только для ООО
bank string Нет Название банка
bik string Нет БИК счета организации
corrBill string Нет Номер корреспондентского счета
billNumber string Нет Номер счета организации
stampPath string Нет Ссылка на изображение печати организации
stampUrl string Нет Ссылка на изображение печати организации
stampSize integer · int32 Нет Размер в байтах изображения печати организации
stampWidth integer · int32 Нет Ширина изображения печати организации
stampHeight integer · int32 Нет Высота изображения печати организации
signaturePath string Нет Фото подписи директора организации
signatureUrl string Нет Фото подписи директора организации
signatureSize integer · int32 Нет Размер файла в байтах подписи директора организации
signatureWidth integer · int32 Нет Ширина изображения подписи директора
signatureHeight integer · int32 Нет Высота изображения подписи директора
ipPerson Person Нет Руководитель организации или ИП
Поля объекта Person
ПолеТипОбязательноОписание
personId integer · int64 Нет Поле personId.
firstName string Да Имя сотрудника
lastName string Да Фамилия сотрудника
surName string Нет Отчество сотрудника
clientId integer · int64 Нет Идентификатор клиента
position PersonPosition Да Должность сотрудника
versionId integer · int64 Нет Поле нужно передавать при изменении,для предотвращения одновременной перезаписи
createdUser string Нет Проставляется автоматически. Пользователь создавший сотрудника
createdDate string · date-time Нет Проставляется автоматически. Дата создания сотрудника
deleted boolean Нет Признак удаления сотрудника
userId integer · int32 Нет Связь сотрудника с пользователем
hasChanges boolean Нет Поле hasChanges.
fullName string Нет Полные ФИО
shortName string Нет Фамилия и инициалы
form stringOOO, IP, SELF_EMPLOYED Да Организационно правовая форма
ip boolean Нет Поле ip.
clientId integer · int64 Нет Идентификатор клиента
address Address Нет Адресс организации
Поля объекта Address
ПолеТипОбязательноОписание
id integer · int32 Нет Поле id.
postCode string Нет Поле postCode.
country Country Нет Поле country.
region Region Нет Поле region.
regionId integer · int32 Нет Поле regionId.
street string Нет Поле street.
house string Нет Поле house.
district string Нет Поле district.
city string Нет Поле city.
locality string Нет Поле locality.
building string Нет Поле building.
flat string Нет Поле flat.
short string Нет Поле short.
addressId Address Нет Поле addressId.
full string Нет Поле full.
phoneNumber string Нет Номер телефона
addressFull string Нет Полный адрес
additionalServiceForTariff DeliveryTariff Нет Поле additionalServiceForTariff.
Поля объекта DeliveryTariff
ПолеТипОбязательноОписание
deliverySum number · float Нет Стоимость доставки
periodMin integer · int32 Нет Минимальное время доставки (в рабочих днях)
periodMax integer · int32 Нет Максимальное время доставки (в рабочих днях)
calendarMin integer · int32 Нет Минимальное время доставки (в календарных днях)
calendarMax integer · int32 Нет Максимальное время доставки (в календарных днях)
tariffId integer · int32 Нет Уникальный идентификатор
shippingService stringCDEK, OWN_DELIVERY, POST, BOXBERRY, DPD, YANDEX, DOSTAVISTA, DELLIN, PEC, YANDEX_EXPRESS, FIVE_POST Нет Сервис доставки, которому принадлежит данный тариф
tariffCode integer · int32 Нет Код тарифа
externalTariffCode string Нет Внешний строковый идентификатор тарифа или предложения
tariffName string Нет Название тарифа
tariffDescription string Нет Описание тарифа
deliveryMode integer · int320, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 Нет Режим доставки
additionalServices AdditionalDeliveryServiceDto[] Нет Дополнительные услуги к тарифу
Структура элемента массива AdditionalDeliveryServiceDto
ПолеТипОбязательноОписание
code string Нет Поле code.
name string Нет Поле name.
description string Нет Поле description.
[
  "string"
]
Ошибки7

Прикладные ошибки обычно возвращаются как JSON с полями error, localMessage и params. Ориентируйтесь на error; локализованный текст может меняться. Как API возвращает прикладные ошибки ↑

401auth_required
Требуется авторизация

Заголовок Authorization отсутствует, пуст или содержит недействительный токен.

400error_access_denied
Недостаточно прав

Токен существует, но его роль не позволяет выполнить операцию.

500error_unknown
Непредвиденная ошибка

Внутренняя ошибка. Сохраните время запроса и обратитесь в поддержку, не повторяя мутацию вслепую.

400error_no_client
Клиент не найден или был удален. Напишите в поддержку

Персональная ошибка этого метода. Для программной логики используйте стабильный код error_no_client; localMessage содержит приведённый выше перевод.

400error_no_warehouse_delivery
Не указан пункт отправления для транспортной компании

Персональная ошибка этого метода. Для программной логики используйте стабильный код error_no_warehouse_delivery; localMessage содержит приведённый выше перевод.

400error_organization_not_found
Не найдена организация

Персональная ошибка этого метода. Для программной логики используйте стабильный код error_organization_not_found; localMessage содержит приведённый выше перевод.

400error_subscription_expired
У вас закончился срок действия тарифа. Оплатите тариф для продолжения использования сервиса.

Персональная ошибка этого метода. Для программной логики используйте стабильный код error_subscription_expired; localMessage содержит приведённый выше перевод.

GET

Выбрать регионы доставки

/api/delivery/getRegions
Токен с правами чтения

Выбрать регионы доставки.

Параметры запроса

ПолеТипОбязательноОписание
query string Да Поисковый запрос для фильтрации регионов
service stringCDEK, OWN_DELIVERY, POST, BOXBERRY, DPD, YANDEX, DOSTAVISTA, DELLIN, PEC, YANDEX_EXPRESS, FIVE_POST Да Поле service.
organizationId integer · int64 Да Поле organizationId.
curl --request GET 'https://api.selsup.ru/api/delivery/getRegions?query=string&service=CDEK&organizationId=1001' \
  --header 'Authorization: YOUR_API_TOKEN'

Успешный ответ

200
Структура элемента массива DeliveryRegion[]
ПолеТипОбязательноОписание
name string Нет Поле name.
id string Нет Поле id.
[
  "string"
]
Ошибки3

Прикладные ошибки обычно возвращаются как JSON с полями error, localMessage и params. Ориентируйтесь на error; локализованный текст может меняться. Как API возвращает прикладные ошибки ↑

401auth_required
Требуется авторизация

Заголовок Authorization отсутствует, пуст или содержит недействительный токен.

400error_access_denied
Недостаточно прав

Токен существует, но его роль не позволяет выполнить операцию.

500error_unknown
Непредвиденная ошибка

Внутренняя ошибка. Сохраните время запроса и обратитесь в поддержку, не повторяя мутацию вслепую.

GET

Выбрать пункты доставки

/api/delivery/getPoints
Токен с правами чтения

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

Параметры запроса

ПолеТипОбязательноОписание
postCode string Нет Поле postCode.
country string Нет Поле country.
region string Нет Поле region.
city string Нет Поле city.
query string Нет Поле query.
forSupply boolean Нет Поле forSupply.
service stringCDEK, OWN_DELIVERY, POST, BOXBERRY, DPD, YANDEX, DOSTAVISTA, DELLIN, PEC, YANDEX_EXPRESS, FIVE_POST Да Поле service.
organizationId integer · int64 Да Поле organizationId.
curl --request GET 'https://api.selsup.ru/api/delivery/getPoints?service=CDEK&organizationId=1001' \
  --header 'Authorization: YOUR_API_TOKEN'

Успешный ответ

200
Структура элемента массива DeliveryPoint[]
ПолеТипОбязательноОписание
name string Нет Поле name.
location DeliveryPointsLocation Нет Поле location.
Поля объекта DeliveryPointsLocation
ПолеТипОбязательноОписание
address string Нет Строка адреса
code integer · int32 Нет Код населенного пункта СДЭК
postal_code string Нет Почтовый индекс
country_code string Нет Код страны в формате ISO_3166-1_alpha-2
city string Нет Название города
fias_guid string Нет Уникальный идентификатор ФИАС населенного пункта
longitude number · float Нет Долгота центра населенного пункта
latitude number · float Нет Широта центра населенного пункта
region string Нет Название региона населенного пункта
region_code integer · int32 Нет Код региона СДЭК
address_full string Нет Строка адреса
city_code string Нет Код населенного пункта СДЭК
address string Нет Поле address.
addressComment string Нет Поле addressComment.
note string Нет Поле note.
workTime string Нет Поле workTime.
phones Phone[] Нет Поле phones.
Структура элемента массива Phone
ПолеТипОбязательноОписание
number string Нет Номер телефонаДолжен передаваться в международном формате: код страны (для России +7) и сам номер (10 и более цифр)
additional string Нет Дополнительная информация (добавочный номер)
zipCode string Нет Поле zipCode.
code string Нет Поле code.
email string Нет Поле email.
site string Нет Поле site.
[
  "string"
]
Ошибки9

Прикладные ошибки обычно возвращаются как JSON с полями error, localMessage и params. Ориентируйтесь на error; локализованный текст может меняться. Как API возвращает прикладные ошибки ↑

401auth_required
Требуется авторизация

Заголовок Authorization отсутствует, пуст или содержит недействительный токен.

400error_access_denied
Недостаточно прав

Токен существует, но его роль не позволяет выполнить операцию.

500error_unknown
Непредвиденная ошибка

Внутренняя ошибка. Сохраните время запроса и обратитесь в поддержку, не повторяя мутацию вслепую.

400error_empty_delivery_service
Не указана служба доставки

Персональная ошибка этого метода. Для программной логики используйте стабильный код error_empty_delivery_service; localMessage содержит приведённый выше перевод.

400error_no_client
Клиент не найден или был удален. Напишите в поддержку

Персональная ошибка этого метода. Для программной логики используйте стабильный код error_no_client; localMessage содержит приведённый выше перевод.

400error_no_delivery_integration
Не настроена интеграция с данной службой доставки

Персональная ошибка этого метода. Для программной логики используйте стабильный код error_no_delivery_integration; localMessage содержит приведённый выше перевод.

400error_organization_not_found
Не найдена организация

Персональная ошибка этого метода. Для программной логики используйте стабильный код error_organization_not_found; localMessage содержит приведённый выше перевод.

400error_subscription_expired
У вас закончился срок действия тарифа. Оплатите тариф для продолжения использования сервиса.

Персональная ошибка этого метода. Для программной логики используйте стабильный код error_subscription_expired; localMessage содержит приведённый выше перевод.

400error_unsupported_delivery_service
служба доставки не поддерживается

Персональная ошибка этого метода. Для программной логики используйте стабильный код error_unsupported_delivery_service; localMessage содержит приведённый выше перевод.

GET

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

/api/delivery/getDeliveryTariffs
Токен с правами чтения

Получить все возможные тарифы для выбранного сервиса доставки.

Параметры запроса

ПолеТипОбязательноОписание
service stringCDEK, OWN_DELIVERY, POST, BOXBERRY, DPD, YANDEX, DOSTAVISTA, DELLIN, PEC, YANDEX_EXPRESS, FIVE_POST Да Поле service.
query string Да Поле query.
curl --request GET 'https://api.selsup.ru/api/delivery/getDeliveryTariffs?service=CDEK&query=string' \
  --header 'Authorization: YOUR_API_TOKEN'

Успешный ответ

200
Структура элемента массива DeliveryTariff[]
ПолеТипОбязательноОписание
deliverySum number · float Нет Стоимость доставки
periodMin integer · int32 Нет Минимальное время доставки (в рабочих днях)
periodMax integer · int32 Нет Максимальное время доставки (в рабочих днях)
calendarMin integer · int32 Нет Минимальное время доставки (в календарных днях)
calendarMax integer · int32 Нет Максимальное время доставки (в календарных днях)
tariffId integer · int32 Нет Уникальный идентификатор
shippingService stringCDEK, OWN_DELIVERY, POST, BOXBERRY, DPD, YANDEX, DOSTAVISTA, DELLIN, PEC, YANDEX_EXPRESS, FIVE_POST Нет Сервис доставки, которому принадлежит данный тариф
tariffCode integer · int32 Нет Код тарифа
externalTariffCode string Нет Внешний строковый идентификатор тарифа или предложения
tariffName string Нет Название тарифа
tariffDescription string Нет Описание тарифа
deliveryMode integer · int320, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 Нет Режим доставки
additionalServices AdditionalDeliveryServiceDto[] Нет Дополнительные услуги к тарифу
Структура элемента массива AdditionalDeliveryServiceDto
ПолеТипОбязательноОписание
code string Нет Поле code.
name string Нет Поле name.
description string Нет Поле description.
[
  "string"
]
Ошибки3

Прикладные ошибки обычно возвращаются как JSON с полями error, localMessage и params. Ориентируйтесь на error; локализованный текст может меняться. Как API возвращает прикладные ошибки ↑

401auth_required
Требуется авторизация

Заголовок Authorization отсутствует, пуст или содержит недействительный токен.

400error_access_denied
Недостаточно прав

Токен существует, но его роль не позволяет выполнить операцию.

500error_unknown
Непредвиденная ошибка

Внутренняя ошибка. Сохраните время запроса и обратитесь в поддержку, не повторяя мутацию вслепую.

GET

Выбрать город доставки

/api/delivery/getCities
Токен с правами чтения

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

Параметры запроса

ПолеТипОбязательноОписание
query string Да Поисковый запрос для фильтрации городов
region string Да Фильтр по региону - передается код региона из саджеста для выбранной службы доставки
service stringCDEK, OWN_DELIVERY, POST, BOXBERRY, DPD, YANDEX, DOSTAVISTA, DELLIN, PEC, YANDEX_EXPRESS, FIVE_POST Да Служба доставки
organizationId integer · int64 Да Организация
curl --request GET 'https://api.selsup.ru/api/delivery/getCities?query=string&region=string&service=CDEK&organizationId=1001' \
  --header 'Authorization: YOUR_API_TOKEN'

Успешный ответ

200
Структура элемента массива DeliveryCity[]
ПолеТипОбязательноОписание
name string Нет Поле name.
id string Нет Поле id.
[
  "string"
]
Ошибки3

Прикладные ошибки обычно возвращаются как JSON с полями error, localMessage и params. Ориентируйтесь на error; локализованный текст может меняться. Как API возвращает прикладные ошибки ↑

401auth_required
Требуется авторизация

Заголовок Authorization отсутствует, пуст или содержит недействительный токен.

400error_access_denied
Недостаточно прав

Токен существует, но его роль не позволяет выполнить операцию.

500error_unknown
Непредвиденная ошибка

Внутренняя ошибка. Сохраните время запроса и обратитесь в поддержку, не повторяя мутацию вслепую.

GET

Выбрать адрес получателя

/api/delivery/getAddress
Токен с правами чтения

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

Параметры запроса

ПолеТипОбязательноОписание
postCode string Нет Поле postCode.
country string Нет Поле country.
region string Нет Поле region.
city string Нет Поле city.
query string Нет Поле query.
forSupply boolean Нет Поле forSupply.
curl --request GET 'https://api.selsup.ru/api/delivery/getAddress' \
  --header 'Authorization: YOUR_API_TOKEN'

Успешный ответ

200
Структура элемента массива AddressDto[]
ПолеТипОбязательноОписание
address string Нет Адрес найденного объекта
postalCode string Нет Индекс почтового отделения
region string Нет Область/Край
locality string Нет Населённый пункт
street string Нет Улица
house string Нет Отдельный дом
longitude number · double Нет Долгота
latitude number · double Нет Широта
[
  "string"
]
Ошибки4

Прикладные ошибки обычно возвращаются как JSON с полями error, localMessage и params. Ориентируйтесь на error; локализованный текст может меняться. Как API возвращает прикладные ошибки ↑

401auth_required
Требуется авторизация

Заголовок Authorization отсутствует, пуст или содержит недействительный токен.

400error_access_denied
Недостаточно прав

Токен существует, но его роль не позволяет выполнить операцию.

500error_unknown
Непредвиденная ошибка

Внутренняя ошибка. Сохраните время запроса и обратитесь в поддержку, не повторяя мутацию вслепую.

400error_cant_get_address
Не удается получить адрес доставки

Персональная ошибка этого метода. Для программной логики используйте стабильный код error_cant_get_address; localMessage содержит приведённый выше перевод.

GET

Дополнительные услуги сервиса доставки

/api/delivery/fetchDeliveryServiceAdditionalServices
Токен с правами чтения

Дополнительные услуги сервиса доставки.

Параметры запроса

ПолеТипОбязательноОписание
service stringCDEK, OWN_DELIVERY, POST, BOXBERRY, DPD, YANDEX, DOSTAVISTA, DELLIN, PEC, YANDEX_EXPRESS, FIVE_POST Да Сервис доставки
tariffCode integer · int32 Нет Код тарифа
curl --request GET 'https://api.selsup.ru/api/delivery/fetchDeliveryServiceAdditionalServices?service=CDEK' \
  --header 'Authorization: YOUR_API_TOKEN'

Успешный ответ

200
Структура элемента массива AdditionalDeliveryServiceDto[]
ПолеТипОбязательноОписание
code string Нет Поле code.
name string Нет Поле name.
description string Нет Поле description.
[
  "string"
]
Ошибки3

Прикладные ошибки обычно возвращаются как JSON с полями error, localMessage и params. Ориентируйтесь на error; локализованный текст может меняться. Как API возвращает прикладные ошибки ↑

401auth_required
Требуется авторизация

Заголовок Authorization отсутствует, пуст или содержит недействительный токен.

400error_access_denied
Недостаточно прав

Токен существует, но его роль не позволяет выполнить операцию.

500error_unknown
Непредвиденная ошибка

Внутренняя ошибка. Сохраните время запроса и обратитесь в поддержку, не повторяя мутацию вслепую.

DELETE

Удалить интеграцию с сервисом доставки

/api/delivery/{service}/{organizationId}
Токен с правами записи

Позволяет удалить интеграцию с сервисом доставки

Параметры пути

ПолеТипОбязательноОписание
service stringCDEK, OWN_DELIVERY, POST, BOXBERRY, DPD, YANDEX, DOSTAVISTA, DELLIN, PEC, YANDEX_EXPRESS, FIVE_POST Да Сервис доставки
organizationId integer · int64 Да Организация
curl --request DELETE 'https://api.selsup.ru/api/delivery/CDEK/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

Успешный ответ

200

Тело ответа пустое.

Ошибки3

Прикладные ошибки обычно возвращаются как JSON с полями error, localMessage и params. Ориентируйтесь на error; локализованный текст может меняться. Как API возвращает прикладные ошибки ↑

401auth_required
Требуется авторизация

Заголовок Authorization отсутствует, пуст или содержит недействительный токен.

400error_access_denied
Недостаточно прав

Токен существует, но его роль не позволяет выполнить операцию.

500error_unknown
Непредвиденная ошибка

Внутренняя ошибка. Сохраните время запроса и обратитесь в поддержку, не повторяя мутацию вслепую.

Authorization

Токен для тестовых запросов

Токен хранится только в localStorage этого браузера и отправляется исключительно в заголовке Authorization запросов к api.selsup.ru.

Попробовать

Параметры реального запроса

Реальный ответ API

Выполните запрос, чтобы увидеть ответ SelSup.