Настройки

Методы для управления различными настройками

Базовый URL: https://api.selsup.ru

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

Изменяет настройки для компонента
POST /api/property/updateProperty

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

Название Тип Обязательный Описание
organizationId integer Нет Идентификатор организации
clientId integer Нет Идентификатор клиента
component string Нет Компонент для настройки
name string Нет Название свойства. Пример для МойСклад контрагент: "contractor.Ozon"; договор: "contract.WB"
value string Нет Значение свойства
valueName integer Нет Название значения - в случае когда в value передается ID

Тело ответа

✓ 200 OK ▶
⚠ 400 Ошибка с данными запроса ▶
Content-Type: application/json
Поле Тип Описание
error Обязательный string Код ошибки
localMessage Обязательный string Текст ошибки на языке пользователя
params object Дополнительные параметры ошибки
⚠ 403 Доступ запрещен ▶
Content-Type: application/json
Поле Тип Описание
error Обязательный string Код ошибки
✗ 500 Внутренняя ошибка сервера ▶
Content-Type: application/json
Поле Тип Описание
error Обязательный string Код ошибки
message string Описание ошибки
system string Системная ошибки парсинга данных запроса
Укажите ключ API в правом верхнем углу, чтобы попробовать использовать метод

Примеры кода

const axios = require('axios');

const params = {
  organizationId: 'АО "Торговый дом"',
  clientId: 'Пример clientId',
  component: 'Пример component',
  name: 'Иван',
  value: 'Пример value',
  valueName: 'Название valueName',
};

const response = await axios.post('https://api.selsup.ru/api/property/updateProperty',
  {
    params,
    headers: {
      'Authorization': 'YOUR_API_KEY',
      'Content-Type': 'application/json'
    }
  }
);

console.log(response.data);
import axios from 'axios';

interface QueryParams {
  organizationId?: string;
  clientId?: string;
  component?: string;
  name?: string;
  value?: string;
  valueName?: string;
}

const params: QueryParams = {
  organizationId: 'АО "Торговый дом"',
  clientId: 'Пример clientId',
  component: 'Пример component',
  name: 'Иван',
  value: 'Пример value',
  valueName: 'Название valueName',
};

const response = await axios.post<any>('https://api.selsup.ru/api/property/updateProperty',
  {
    params,
    headers: {
      'Authorization': 'YOUR_API_KEY',
      'Content-Type': 'application/json'
    }
  }
);

console.log(response.data);
import requests

headers = {
    'Authorization': 'YOUR_API_KEY',
    'Content-Type': 'application/json'
}

params = {
    'organizationId': 'АО "Торговый дом"',
    'clientId': 'Пример clientId',
    'component': 'Пример component',
    'name': 'Иван',
    'value': 'Пример value',
    'valueName': 'Название valueName',
}

response = requests.post(
    'https://api.selsup.ru/api/property/updateProperty',
    headers=headers,
    params=params
)

print(response.json())
package main

import (
    "bytes"
    "encoding/json"
    "fmt"
    "net/http"
)

func main() {
    client := &http.Client{}

    req, _ := http.NewRequest("post", "https://api.selsup.ru/api/property/updateProperty?organizationId=%D0%90%D0%9E%20%22%D0%A2%D0%BE%D1%80%D0%B3%D0%BE%D0%B2%D1%8B%D0%B9%20%D0%B4%D0%BE%D0%BC%22&clientId=%D0%9F%D1%80%D0%B8%D0%BC%D0%B5%D1%80%20clientId&component=%D0%9F%D1%80%D0%B8%D0%BC%D0%B5%D1%80%20component&name=%D0%98%D0%B2%D0%B0%D0%BD&value=%D0%9F%D1%80%D0%B8%D0%BC%D0%B5%D1%80%20value&valueName=%D0%9D%D0%B0%D0%B7%D0%B2%D0%B0%D0%BD%D0%B8%D0%B5%20valueName", nil)
    req.Header.Set("Authorization", "YOUR_API_KEY")
    req.Header.Set("Content-Type", "application/json")

    resp, err := client.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    var result map[string]interface{}
    json.NewDecoder(resp.Body).Decode(&result)
    fmt.Println(result)
}
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.URI;

HttpClient client = HttpClient.newHttpClient();

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.selsup.ru/api/property/updateProperty?organizationId=%D0%90%D0%9E%20%22%D0%A2%D0%BE%D1%80%D0%B3%D0%BE%D0%B2%D1%8B%D0%B9%20%D0%B4%D0%BE%D0%BC%22&clientId=%D0%9F%D1%80%D0%B8%D0%BC%D0%B5%D1%80%20clientId&component=%D0%9F%D1%80%D0%B8%D0%BC%D0%B5%D1%80%20component&name=%D0%98%D0%B2%D0%B0%D0%BD&value=%D0%9F%D1%80%D0%B8%D0%BC%D0%B5%D1%80%20value&valueName=%D0%9D%D0%B0%D0%B7%D0%B2%D0%B0%D0%BD%D0%B8%D0%B5%20valueName"))
    .header("Authorization", "YOUR_API_KEY")
    .header("Content-Type", "application/json")
    .post(HttpRequest.BodyPublishers.noBody())
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
<?php
$curl = curl_init();

$params = [
    'organizationId' => 'АО "Торговый дом"',
    'clientId' => 'Пример clientId',
    'component' => 'Пример component',
    'name' => 'Иван',
    'value' => 'Пример value',
    'valueName' => 'Название valueName',
];

$url = 'https://api.selsup.ru/api/property/updateProperty?' . http_build_query($params);

curl_setopt_array($curl, [
    CURLOPT_URL => $url,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'post',
    CURLOPT_HTTPHEADER => [
        'Authorization: YOUR_API_KEY',
        'Content-Type: application/json'
    ]
]);

$response = curl_exec($curl);
curl_close($curl);

echo $response;
?>
curl -X post \
  'https://api.selsup.ru/api/property/updateProperty?organizationId=%D0%90%D0%9E%20%22%D0%A2%D0%BE%D1%80%D0%B3%D0%BE%D0%B2%D1%8B%D0%B9%20%D0%B4%D0%BE%D0%BC%22&clientId=%D0%9F%D1%80%D0%B8%D0%BC%D0%B5%D1%80%20clientId&component=%D0%9F%D1%80%D0%B8%D0%BC%D0%B5%D1%80%20component&name=%D0%98%D0%B2%D0%B0%D0%BD&value=%D0%9F%D1%80%D0%B8%D0%BC%D0%B5%D1%80%20value&valueName=%D0%9D%D0%B0%D0%B7%D0%B2%D0%B0%D0%BD%D0%B8%D0%B5%20valueName' \
  -H 'Authorization: YOUR_API_KEY' \
  -H 'Content-Type: application/json'

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

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

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

Название Тип Обязательный Описание
organizationId integer Да Организация для настроек. Можно не передавать, если настройки не зависят от организации
component string Да Компонент, для которого сохраняются настройки

Тело ответа

✓ 200 OK ▶
Тип: object
⚠ 400 Ошибка с данными запроса ▶
Content-Type: application/json
Поле Тип Описание
error Обязательный string Код ошибки
localMessage Обязательный string Текст ошибки на языке пользователя
params object Дополнительные параметры ошибки
⚠ 403 Доступ запрещен ▶
Content-Type: application/json
Поле Тип Описание
error Обязательный string Код ошибки
✗ 500 Внутренняя ошибка сервера ▶
Content-Type: application/json
Поле Тип Описание
error Обязательный string Код ошибки
message string Описание ошибки
system string Системная ошибки парсинга данных запроса
Укажите ключ API в правом верхнем углу, чтобы попробовать использовать метод

Примеры кода

const axios = require('axios');

const params = {
  organizationId: 'АО "Торговый дом"',
  component: 'Пример component',
};

const response = await axios.get('https://api.selsup.ru/api/property/getProperties',
  {
    params,
    headers: {
      'Authorization': 'YOUR_API_KEY',
      'Content-Type': 'application/json'
    }
  }
);

console.log(response.data);
import axios from 'axios';

interface QueryParams {
  organizationId?: number;
  component?: string;
}

const params: QueryParams = {
  organizationId: 'АО "Торговый дом"',
  component: 'Пример component',
};

const response = await axios.get<any>('https://api.selsup.ru/api/property/getProperties',
  {
    params,
    headers: {
      'Authorization': 'YOUR_API_KEY',
      'Content-Type': 'application/json'
    }
  }
);

console.log(response.data);
import requests

headers = {
    'Authorization': 'YOUR_API_KEY',
    'Content-Type': 'application/json'
}

params = {
    'organizationId': 'АО "Торговый дом"',
    'component': 'Пример component',
}

response = requests.get(
    'https://api.selsup.ru/api/property/getProperties',
    headers=headers,
    params=params
)

print(response.json())
package main

import (
    "bytes"
    "encoding/json"
    "fmt"
    "net/http"
)

func main() {
    client := &http.Client{}

    req, _ := http.NewRequest("get", "https://api.selsup.ru/api/property/getProperties?organizationId=%D0%90%D0%9E%20%22%D0%A2%D0%BE%D1%80%D0%B3%D0%BE%D0%B2%D1%8B%D0%B9%20%D0%B4%D0%BE%D0%BC%22&component=%D0%9F%D1%80%D0%B8%D0%BC%D0%B5%D1%80%20component", nil)
    req.Header.Set("Authorization", "YOUR_API_KEY")
    req.Header.Set("Content-Type", "application/json")

    resp, err := client.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    var result map[string]interface{}
    json.NewDecoder(resp.Body).Decode(&result)
    fmt.Println(result)
}
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.URI;

HttpClient client = HttpClient.newHttpClient();

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.selsup.ru/api/property/getProperties?organizationId=%D0%90%D0%9E%20%22%D0%A2%D0%BE%D1%80%D0%B3%D0%BE%D0%B2%D1%8B%D0%B9%20%D0%B4%D0%BE%D0%BC%22&component=%D0%9F%D1%80%D0%B8%D0%BC%D0%B5%D1%80%20component"))
    .header("Authorization", "YOUR_API_KEY")
    .header("Content-Type", "application/json")
    .get(HttpRequest.BodyPublishers.noBody())
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
<?php
$curl = curl_init();

$params = [
    'organizationId' => 'АО "Торговый дом"',
    'component' => 'Пример component',
];

$url = 'https://api.selsup.ru/api/property/getProperties?' . http_build_query($params);

curl_setopt_array($curl, [
    CURLOPT_URL => $url,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'get',
    CURLOPT_HTTPHEADER => [
        'Authorization: YOUR_API_KEY',
        'Content-Type: application/json'
    ]
]);

$response = curl_exec($curl);
curl_close($curl);

echo $response;
?>
curl -X get \
  'https://api.selsup.ru/api/property/getProperties?organizationId=%D0%90%D0%9E%20%22%D0%A2%D0%BE%D1%80%D0%B3%D0%BE%D0%B2%D1%8B%D0%B9%20%D0%B4%D0%BE%D0%BC%22&component=%D0%9F%D1%80%D0%B8%D0%BC%D0%B5%D1%80%20component' \
  -H 'Authorization: YOUR_API_KEY' \
  -H 'Content-Type: application/json'

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

Получает список сохраненных настроек для компонента
GET /api/property/getPropertiesList

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

Название Тип Обязательный Описание
component string Да Компонент, для которого получаются настройки
organizationId integer Нет Параметр organizationId

Тело ответа

✓ 200 OK ▶
Content-Type: application/json
Тип ответа: Property Различные настройки SelSup
Элементы массива
Поле Тип Описание
organizationId integer Нет Идентификатор организации
clientId integer Нет Идентификатор клиента
component string Нет Компонент для настройки
name string Нет Название свойства. Пример для МойСклад контрагент: "contractor.Ozon"; договор: "contract.WB"
value string Нет Значение свойства
valueName string Нет Название значения - в случае когда в value передается ID
⚠ 400 Ошибка с данными запроса ▶
Content-Type: application/json
Поле Тип Описание
error Обязательный string Код ошибки
localMessage Обязательный string Текст ошибки на языке пользователя
params object Дополнительные параметры ошибки
⚠ 403 Доступ запрещен ▶
Content-Type: application/json
Поле Тип Описание
error Обязательный string Код ошибки
✗ 500 Внутренняя ошибка сервера ▶
Content-Type: application/json
Поле Тип Описание
error Обязательный string Код ошибки
message string Описание ошибки
system string Системная ошибки парсинга данных запроса
Укажите ключ API в правом верхнем углу, чтобы попробовать использовать метод

Примеры кода

const axios = require('axios');

const params = {
  component: 'Пример component',
  organizationId: 'АО "Торговый дом"',
};

const response = await axios.get('https://api.selsup.ru/api/property/getPropertiesList',
  {
    params,
    headers: {
      'Authorization': 'YOUR_API_KEY',
      'Content-Type': 'application/json'
    }
  }
);

console.log(response.data);
import axios from 'axios';

interface QueryParams {
  component?: string;
  organizationId?: number;
}

const params: QueryParams = {
  component: 'Пример component',
  organizationId: 'АО "Торговый дом"',
};

const response = await axios.get<any>('https://api.selsup.ru/api/property/getPropertiesList',
  {
    params,
    headers: {
      'Authorization': 'YOUR_API_KEY',
      'Content-Type': 'application/json'
    }
  }
);

console.log(response.data);
import requests

headers = {
    'Authorization': 'YOUR_API_KEY',
    'Content-Type': 'application/json'
}

params = {
    'component': 'Пример component',
    'organizationId': 'АО "Торговый дом"',
}

response = requests.get(
    'https://api.selsup.ru/api/property/getPropertiesList',
    headers=headers,
    params=params
)

print(response.json())
package main

import (
    "bytes"
    "encoding/json"
    "fmt"
    "net/http"
)

func main() {
    client := &http.Client{}

    req, _ := http.NewRequest("get", "https://api.selsup.ru/api/property/getPropertiesList?component=%D0%9F%D1%80%D0%B8%D0%BC%D0%B5%D1%80%20component&organizationId=%D0%90%D0%9E%20%22%D0%A2%D0%BE%D1%80%D0%B3%D0%BE%D0%B2%D1%8B%D0%B9%20%D0%B4%D0%BE%D0%BC%22", nil)
    req.Header.Set("Authorization", "YOUR_API_KEY")
    req.Header.Set("Content-Type", "application/json")

    resp, err := client.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    var result map[string]interface{}
    json.NewDecoder(resp.Body).Decode(&result)
    fmt.Println(result)
}
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.URI;

HttpClient client = HttpClient.newHttpClient();

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.selsup.ru/api/property/getPropertiesList?component=%D0%9F%D1%80%D0%B8%D0%BC%D0%B5%D1%80%20component&organizationId=%D0%90%D0%9E%20%22%D0%A2%D0%BE%D1%80%D0%B3%D0%BE%D0%B2%D1%8B%D0%B9%20%D0%B4%D0%BE%D0%BC%22"))
    .header("Authorization", "YOUR_API_KEY")
    .header("Content-Type", "application/json")
    .get(HttpRequest.BodyPublishers.noBody())
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
<?php
$curl = curl_init();

$params = [
    'component' => 'Пример component',
    'organizationId' => 'АО "Торговый дом"',
];

$url = 'https://api.selsup.ru/api/property/getPropertiesList?' . http_build_query($params);

curl_setopt_array($curl, [
    CURLOPT_URL => $url,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'get',
    CURLOPT_HTTPHEADER => [
        'Authorization: YOUR_API_KEY',
        'Content-Type: application/json'
    ]
]);

$response = curl_exec($curl);
curl_close($curl);

echo $response;
?>
curl -X get \
  'https://api.selsup.ru/api/property/getPropertiesList?component=%D0%9F%D1%80%D0%B8%D0%BC%D0%B5%D1%80%20component&organizationId=%D0%90%D0%9E%20%22%D0%A2%D0%BE%D1%80%D0%B3%D0%BE%D0%B2%D1%8B%D0%B9%20%D0%B4%D0%BE%D0%BC%22' \
  -H 'Authorization: YOUR_API_KEY' \
  -H 'Content-Type: application/json'