Настройки

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

01

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

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

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

PUTИзменить настройки GETПолучение настроек GETСписок настроек

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

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

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

Property6 полей

organizationIdinteger · int64

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

clientIdinteger · int64

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

read-only

componentstring

Компонент для настройки

namestring

Название свойства. Пример для МойСклад: контрагент "contractor.Ozon"; договор "contract.WB"; проект: "project.WILDBERRIES" (для всех); "project.WILDBERRIES.FBO" (тип FBO); "project.WILDBERRIES.FBO.express" (FBO экспресс); "project.WILDBERRIES.FBO.dbs" (FBO DBS); "project.WILDBERRIES.FBO.express.dbs" (FBO экспресс DBS)

valuestring

Значение свойства

valueNamestring

Название значения - в случае когда в value передается ID

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

Как 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"
  }
}

Методы

PUT

Изменить настройки

/api/property/

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

Изменяет настройки для компонента

Тело запроса

application/json

Поля объектаProperty

Поле	Тип	Обязательно	Описание
`organizationId`	integer · int64	Нет	Идентификатор организации
`clientId`	integer · int64	Нет	Идентификатор клиента
`component`	string	Нет	Компонент для настройки
`name`	string	Нет	Название свойства. Пример для МойСклад: контрагент "contractor.Ozon"; договор "contract.WB"; проект: "project.WILDBERRIES" (для всех); "project.WILDBERRIES.FBO" (тип FBO); "project.WILDBERRIES.FBO.express" (FBO экспресс); "project.WILDBERRIES.FBO.dbs" (FBO DBS); "project.WILDBERRIES.FBO.express.dbs" (FBO экспресс DBS)
`value`	string	Нет	Значение свойства
`valueName`	string	Нет	Название значения - в случае когда в value передается ID

curl --request PUT 'https://api.selsup.ru/api/property/' \
  --header 'Authorization: YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "organizationId": 1001,
  "clientId": 1001,
  "component": "string",
  "name": "Example",
  "value": "string",
  "valueName": "Example"
}'

const response = await fetch('https://api.selsup.ru/api/property/', {
  method: 'PUT',
  headers: {
    Authorization: process.env.SELSUP_API_TOKEN,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "organizationId": 1001,
    "clientId": 1001,
    "component": "string",
    "name": "Example",
    "value": "string",
    "valueName": "Example"
  }),
});

if (!response.ok) {
  const error = await response.json();
  throw new Error(error.error || 'selsup_request_failed');
}

const response: Response = await fetch('https://api.selsup.ru/api/property/', {
  method: 'PUT',
  headers: {
    Authorization: process.env.SELSUP_API_TOKEN!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "organizationId": 1001,
    "clientId": 1001,
    "component": "string",
    "name": "Example",
    "value": "string",
    "valueName": "Example"
  }),
});

if (!response.ok) {
  const error = await response.json() as { error?: string };
  throw new Error(error.error ?? 'selsup_request_failed');
}

import os
import requests

response = requests.put(
    'https://api.selsup.ru/api/property/',
    headers={'Authorization': os.environ['SELSUP_API_TOKEN']},
    json={
        'organizationId': 1001,
        'clientId': 1001,
        'component': 'string',
        'name': 'Example',
        'value': 'string',
        'valueName': 'Example'
    },
)
response.raise_for_status()

<?php

$payload = <<<'JSON'
{
  "organizationId": 1001,
  "clientId": 1001,
  "component": "string",
  "name": "Example",
  "value": "string",
  "valueName": "Example"
}
JSON;

$curl = curl_init();
curl_setopt_array($curl, [
    CURLOPT_URL => 'https://api.selsup.ru/api/property/',
    CURLOPT_CUSTOMREQUEST => 'PUT',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['Authorization: ' . getenv('SELSUP_API_TOKEN'), 'Content-Type: application/json'],
    CURLOPT_POSTFIELDS => $payload,
]);

$response = curl_exec($curl);
$status = curl_getinfo($curl, CURLINFO_HTTP_CODE);
curl_close($curl);

if ($response === false || $status >= 400) {
    throw new RuntimeException($response ?: 'selsup_request_failed');
}

echo $response;

package main

import (
    "fmt"
    "io"
    "net/http"
    "os"
    "strings"
)

func main() {
    req, err := http.NewRequest("PUT", "https://api.selsup.ru/api/property/", strings.NewReader(`{
  "organizationId": 1001,
  "clientId": 1001,
  "component": "string",
  "name": "Example",
  "value": "string",
  "valueName": "Example"
}`))
    if err != nil { panic(err) }
    req.Header.Set("Authorization", os.Getenv("SELSUP_API_TOKEN"))
    req.Header.Set("Content-Type", "application/json")

    response, err := http.DefaultClient.Do(req)
    if err != nil { panic(err) }
    defer response.Body.Close()
    result, _ := io.ReadAll(response.Body)
    fmt.Printf("%d\n%s\n", response.StatusCode, result)
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class SelSupExample {
    public static void main(String[] args) throws Exception {
        HttpRequest request = HttpRequest.newBuilder(URI.create("https://api.selsup.ru/api/property/"))
            .header("Authorization", System.getenv("SELSUP_API_TOKEN"))
            .header("Content-Type", "application/json")
            .method("PUT", HttpRequest.BodyPublishers.ofString("""
{
  "organizationId": 1001,
  "clientId": 1001,
  "component": "string",
  "name": "Example",
  "value": "string",
  "valueName": "Example"
}
"""))
            .build();

        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.statusCode());
        System.out.println(response.body());
    }
}

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

200

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

Ошибки5

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

401auth_required

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

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

400error_access_denied

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

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

500error_unknown

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

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

400error_invalid_currency_source

Указанный источник курса валют не поддерживается

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

400error_no_client

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

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

GET

Получение настроек

/api/property/{organizationId}/{component}

Токен с правами чтения

Получает сохраненные настройки для компонента

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

Поле	Тип	Обязательно	Описание
`organizationId`	integer · int64	Да	Поле organizationId.
`component`	string	Да	Поле component.

curl --request GET 'https://api.selsup.ru/api/property/1001/string' \
  --header 'Authorization: YOUR_API_TOKEN'

const response = await fetch('https://api.selsup.ru/api/property/1001/string', {
  method: 'GET',
  headers: { Authorization: process.env.SELSUP_API_TOKEN },
});

if (!response.ok) {
  const error = await response.json();
  throw new Error(error.error || 'selsup_request_failed');
}

const result = await response.json();

const response: Response = await fetch('https://api.selsup.ru/api/property/1001/string', {
  method: 'GET',
  headers: { Authorization: process.env.SELSUP_API_TOKEN! },
});

if (!response.ok) {
  const error = await response.json() as { error?: string };
  throw new Error(error.error ?? 'selsup_request_failed');
}

const result: unknown = await response.json();

import os
import requests

response = requests.get(
    'https://api.selsup.ru/api/property/1001/string',
    headers={'Authorization': os.environ['SELSUP_API_TOKEN']},
)
response.raise_for_status()
result = response.json()

<?php

$curl = curl_init();
curl_setopt_array($curl, [
    CURLOPT_URL => 'https://api.selsup.ru/api/property/1001/string',
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['Authorization: ' . getenv('SELSUP_API_TOKEN')],
]);

$response = curl_exec($curl);
$status = curl_getinfo($curl, CURLINFO_HTTP_CODE);
curl_close($curl);

if ($response === false || $status >= 400) {
    throw new RuntimeException($response ?: 'selsup_request_failed');
}

echo $response;

package main

import (
    "fmt"
    "io"
    "net/http"
    "os"
)

func main() {
    req, err := http.NewRequest("GET", "https://api.selsup.ru/api/property/1001/string", nil)
    if err != nil { panic(err) }
    req.Header.Set("Authorization", os.Getenv("SELSUP_API_TOKEN"))

    response, err := http.DefaultClient.Do(req)
    if err != nil { panic(err) }
    defer response.Body.Close()
    result, _ := io.ReadAll(response.Body)
    fmt.Printf("%d\n%s\n", response.StatusCode, result)
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class SelSupExample {
    public static void main(String[] args) throws Exception {
        HttpRequest request = HttpRequest.newBuilder(URI.create("https://api.selsup.ru/api/property/1001/string"))
            .header("Authorization", System.getenv("SELSUP_API_TOKEN"))
            .method("GET", HttpRequest.BodyPublishers.noBody())
            .build();

        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.statusCode());
        System.out.println(response.body());
    }
}

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

200

"string"

Ошибки7

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

401auth_required

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

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

400error_access_denied

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

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

500error_unknown

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

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

400error_header_logo_upload_failed

Не удалось загрузить логотип. Попробуйте еще раз.

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

400error_no_client

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

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

400error_ozon_fbo_workflow_not_found

Процесс Ozon FBO {id} не найден

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

400error_user_does_not_have_this_organization

У пользователя нет доступа к данной организации

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

GET

Список настроек

/api/property/list/{component}

Токен с правами чтения

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

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

Поле	Тип	Обязательно	Описание
`component`	string	Да	Поле component.

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

Поле	Тип	Обязательно	Описание
`organizationId`	integer · int64	Нет	Поле organizationId.

curl --request GET 'https://api.selsup.ru/api/property/list/string' \
  --header 'Authorization: YOUR_API_TOKEN'

const response = await fetch('https://api.selsup.ru/api/property/list/string', {
  method: 'GET',
  headers: { Authorization: process.env.SELSUP_API_TOKEN },
});

if (!response.ok) {
  const error = await response.json();
  throw new Error(error.error || 'selsup_request_failed');
}

const result = await response.json();

const response: Response = await fetch('https://api.selsup.ru/api/property/list/string', {
  method: 'GET',
  headers: { Authorization: process.env.SELSUP_API_TOKEN! },
});

if (!response.ok) {
  const error = await response.json() as { error?: string };
  throw new Error(error.error ?? 'selsup_request_failed');
}

const result: unknown = await response.json();

import os
import requests

response = requests.get(
    'https://api.selsup.ru/api/property/list/string',
    headers={'Authorization': os.environ['SELSUP_API_TOKEN']},
)
response.raise_for_status()
result = response.json()

<?php

$curl = curl_init();
curl_setopt_array($curl, [
    CURLOPT_URL => 'https://api.selsup.ru/api/property/list/string',
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['Authorization: ' . getenv('SELSUP_API_TOKEN')],
]);

$response = curl_exec($curl);
$status = curl_getinfo($curl, CURLINFO_HTTP_CODE);
curl_close($curl);

if ($response === false || $status >= 400) {
    throw new RuntimeException($response ?: 'selsup_request_failed');
}

echo $response;

package main

import (
    "fmt"
    "io"
    "net/http"
    "os"
)

func main() {
    req, err := http.NewRequest("GET", "https://api.selsup.ru/api/property/list/string", nil)
    if err != nil { panic(err) }
    req.Header.Set("Authorization", os.Getenv("SELSUP_API_TOKEN"))

    response, err := http.DefaultClient.Do(req)
    if err != nil { panic(err) }
    defer response.Body.Close()
    result, _ := io.ReadAll(response.Body)
    fmt.Printf("%d\n%s\n", response.StatusCode, result)
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class SelSupExample {
    public static void main(String[] args) throws Exception {
        HttpRequest request = HttpRequest.newBuilder(URI.create("https://api.selsup.ru/api/property/list/string"))
            .header("Authorization", System.getenv("SELSUP_API_TOKEN"))
            .method("GET", HttpRequest.BodyPublishers.noBody())
            .build();

        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.statusCode());
        System.out.println(response.body());
    }
}

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

200

Структура элемента массива Property[]

Поле	Тип	Обязательно	Описание
`organizationId`	integer · int64	Нет	Идентификатор организации
`clientId`	integer · int64	Нет	Идентификатор клиента
`component`	string	Нет	Компонент для настройки
`name`	string	Нет	Название свойства. Пример для МойСклад: контрагент "contractor.Ozon"; договор "contract.WB"; проект: "project.WILDBERRIES" (для всех); "project.WILDBERRIES.FBO" (тип FBO); "project.WILDBERRIES.FBO.express" (FBO экспресс); "project.WILDBERRIES.FBO.dbs" (FBO DBS); "project.WILDBERRIES.FBO.express.dbs" (FBO экспресс DBS)
`value`	string	Нет	Значение свойства
`valueName`	string	Нет	Название значения - в случае когда в value передается ID

[
  "string"
]

Ошибки4

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

401auth_required

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

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

400error_access_denied

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

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

500error_unknown

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

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

400error_subscription_expired

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

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

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

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

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

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

Методы

Изменить настройки

Тело запроса

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

Получение настроек

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

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

Список настроек

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

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

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

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

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

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